pokeapi.co

pokeapi.co

Этот репозиторий содержит исходный код и документацию для pokeapi.co. Этот веб-сайт построен на React-Static, статическом генераторе сайтов, похожий на Gatsby, за исключением неопинированного и с меньшей магией.

Начиная

Предпосылка

• Git
• Узел: 10.11.0 или более
• Вилка репо (для любых вкладов)
• Клон репо -репо -Pokeapi.co на вашей местной машине

Установка

1. cd pokeapi.co , чтобы перейти в проект root.
2. npm install для установки зависимостей проекта.

Бег на местном уровне

1. npm run start , чтобы запустить сервер разработки горячей загрузки (питание от React-Static).
2. Перейдите на http://localhost:3000 чтобы просмотреть сайт в вашем браузере.

Здание для производства

1. npm run build для создания производственного сайта.
2. npm run serve для обслуживания производственной версии сайта на локальном сервере тестирования.

Производственные файлы расположены в dist каталоге.

Внося

Форк проект

1. Развете проект в свой собственный профиль GitHub.
2. Клонировать раздвоенный репозиторий на местную машину.
3. git remote add upstream https://github.com/PokeAPI/pokeapi.co чтобы создать удаленную ручку для восходящего репо.
4. git pull upstream master чтобы убедиться, что у вас есть последний основной код.
5. git checkout -b branch-name (замена филиала с подходящим именем) для создания ветви для ваших изменений.

Внести изменения

1. Следуйте инструкциям «Запуск локально».
2. Сохраните файлы и проверьте результаты в браузере.

Изменения для реагирования компонентов в /src будут горячими переоборудованием. При изменении файла или файлов /alerts.json в каталоге /src/docs/ вам необходимо будет перезагрузить сервер DEV, прежде чем будут замечены изменения.

Проверьте изменение

Если возможно, проверьте любые визуальные изменения во всех последних версиях общих браузеров, как на рабочем столе, так и на мобильных устройствах.

Толкнуть его

1. git add -A , чтобы поставить ваши измененные файлы.
2. git commit -m "My message" (замена моего сообщения на сообщение о коммите, например, «Fix Logo Header на Android»), чтобы совершить ваши изменения. Хотя это и не важно, постарайтесь следовать руководящим принципам, как написать сообщение GIT Commit.
3. git push my-fork-name branch-name чтобы подтолкнуть ваши изменения в свой собственный репозиторий GitHub.
4. Перейдите в репо pokeapi.co Github, и вы должны увидеть ваши недавно толкованные ветви.
5. Следуйте инструкциям GitHub, чтобы отправить запрос на привлечение.
6. Опишите изменения, которые вы внесли в организм PR. Если возможно, включите скриншоты визуальных изменений.