Перейти к содержимому
ГалоўнаяГайды і інструкцыіСтарт новага праекта: package.json, README і .gitignore

Старт новага праекта: package.json, README і .gitignore

Час чытання: 1 хв

Як хутка стварыць package.json, README і .gitignore для новага праекта: бясплатныя генератары фармуюць файлы па форме — без ручнога рэдагавання.

Запуск новага праекта — гэта не толькі код: яшчэ да першага каміта трэба завесці файл package.json, напісаць README і дадаць .gitignore, каб у рэпазіторый не трапілі залежнасці і лакальныя налады. Запаўняць усё гэта ўручную доўга, а памылка ў package.json можа зламаць устаноўку залежнасцяў.

Крок 1: package.json

package.json Generator збірае файл праз форму: назва праекта, версія, скрыпты (start, build, test), залежнасці і ліцэнзія — без ручнога рэдагавання JSON і рызыкі паставіць лішнюю коску. Гатовы файл можна адразу спампаваць і пакласці ў корань праекта.

Крок 2: README

README Generator за хвіліну стварае структураваны README.md: апісанне праекта, інструкцыя па ўстаноўцы і запуску, прыклады выкарыстання, раздзелы для ліцэнзіі і кантрыб'ютараў. Добры README — першае, што ўбачыць чалавек на старонцы рэпазіторыя, таму лепш падрыхтаваць яго адразу.

Крок 3: .gitignore

Генератар .gitignore фармуе файл пад ваш стэк — Node.js, Python, Java ці некалькі тэхналогій адначасова. Ён адразу дадасць тыповыя выключэнні: node_modules, атачэнні, логі, папкі IDE.

Парада

Выконвайце парадак package.json → README → .gitignore і рабіце першы каміт, калі ўсе тры файлы гатовыя. Калі дадаць .gitignore пазней, ужо закамічаныя node_modules прыйдзецца вычышчаць уручную.

Важна: усе файлы апрацоўваюцца ў браўзеры і не адпраўляюцца на сервер — бяспечна для канфідэнцыйных малюнкаў.