Как создать и зарегистрировать проект в tea.xyz

Один из основных квестов в тестнете tea.xyz является регистрация проекта. Проектом является любой пакет/софт/скрипт, выложенный в пакетном менеджере (npm, pypi, etc..). В данном гайде я вам расскажу как создать проект с помощью ChatGPT и выложить его на npm, который не будет выглядеть как пустышка, что возможно поможет избежать бритья по пустым проектам от tea.

Но, для начала оформляй подписочку на TG-канал авторов гайда dev in 16 и приступай к созданию!

Первым делом скачиваем шаблон приложения. Также, стоит все действия выполнять в IDE, а именно в VS Code. Так же нужно установить Node.js. При установке выберите все доступные опции.

Если у вас нет VS Code, устанавливаем, открываем в нем шаблон и создаем терминал (Ctrl + Shift + ` или Cmd + `)

Заходим в ChatGPT и вбиваем первый промпт:
provide me with ideas for npm package

Он предложит вам варианты:

Выбираем понравившийся и пишем:
create me <название проекта> package in js with code in one file. I will further upload it to npm

В скачанном шаблоне открываем файл src/index.js, куда вставляем первый предложенный код.
Далее, если в ответе ChatGPT говорит, что надо что-то скачать, то выполняем команду для установки в консоли.

Далее просим его написать описание для этого пакета:
make me readme file for this package. provide it in markdown format, but be carefull, when you type in markdown format, you parse it and return as a text, but i need it as code snippet Он может начать писать как надо, но в процессе он может сам начать парсить этот формат и в итоге будет не так как надо. В таком случае перегенерируем ответ пока он не пришлет полное описание в черном прямоугольнике.

Получившийся текст вставляем в файл README.md.

Далее, вам нужно будет заполнить файл package.json инфой о пакете.

На этом создание пакета закончено, теперь мы создадим под него репозиторий.

Создавать репозиторий мы будем на сайте Github, если у вас нет аккаунта, зарегистрируйтесь и продолжайте делать все по гайду.

Итак, переходим на страницу создания нового репозитория: тык.

Выбираем имя для нашего репозитория, можете сделать такое же как и у пакета.

Обязательно оставляем опцию Public. Создаем репозиторий.

Затем открываем терминал в VS Code и вписываем туда команды из первого блока начиная со второй, и вместо третьей команды вписываете git add .

Теперь вы копируете ссылку на ваш репозиторий и вставляете ее в поле url в package.json в таком формате:
https://github.com/<ваш юзернейм>/<название репозитория>.git

С репозиторием закончили, осталось опубликовать пакет.

Публиковать будем в пакетный менеджер npm, на сайте npmjs.com.

Первым делом регистрируемся: тык.

После регистрации возвращаемся в VS Code и в терминале пишем команду
npm adduser

После чего переходим по ссылке и авторизуемся.

После авторизации возвращаемся в терминал и пишем npm publish

На этом все! Спустя 1-5 дней ваш проект появится в регистре tea.xyz и вы сможете зарегистрировать его. Надеюсь, данный гайд вам помог!

Автор: dev in 16