📖
README, npm та package.json
Installation, Usage, Dependencies — що читати першим в незнайомому проєкті
Словник README та npm
| Слово | Переклад |
|---|---|
| Installation | Встановлення |
| Usage / Getting started | Використання / Початок роботи |
| Prerequisites | Попередні вимоги |
| Dependencies | Залежності |
| Dev dependencies | Залежності для розробки |
| License | Ліцензія |
| Contributing | Як долучитися до проєкту |
| Issues | Проблеми / баги |
| Pull request | Запит на злиття коду |
| Fork | Копія репозиторію |
| Clone | Завантажити копію |
package.json — читаємо без страху
'''json { "name": "my-app", "version": "1.0.0", "description": "A simple app", "main": "index.js", "scripts": { "start": "node index.js", "test": "jest" }, "dependencies": { "express": "^4.18.0" }, "devDependencies": { "jest": "^29.0.0" } } '''
- scripts — команди які можна запустити ('npm run start')
- dependencies — потрібні для роботи програми
- devDependencies — потрібні тільки під час розробки (тести тощо)
- '^4.18.0' — caret означає «будь-яка версія 4.x.x»
🛒
Dependencies = список покупок
Dependencies — як список інгредієнтів для рецепту. Твоя програма не спрацює без них. DevDependencies — як інструменти на кухні (ніж, сковорідка): потрібні щоб готувати, але не ідуть разом з готовою стравою до гостя.