generated from goitacademy/react-homework-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ad53c77
commit 2084950
Showing
4 changed files
with
37 additions
and
118 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,113 +1,32 @@ | ||
# React homework template | ||
|
||
Этот проект был создан при помощи | ||
[Create React App](https://github.com/facebook/create-react-app). Для знакомства | ||
и настройки дополнительных возможностей | ||
[обратись к документации](https://facebook.github.io/create-react-app/docs/getting-started). | ||
|
||
## Создание репозитория по шаблону | ||
|
||
Используй этот репозиторий организации GoIT как шаблон для создания репозитория | ||
своего проекта. Для этого нажми на кнопку `«Use this template»` и выбери опцию | ||
`«Create a new repository»`, как показано на изображении. | ||
|
||
![Creating repo from a template step 1](./assets/template-step-1.png) | ||
|
||
На следующем шаге откроется страница создания нового репозитория. Заполни поле | ||
его имени, убедись что репозиторий публичный, после чего нажми кнопку | ||
`«Create repository from template»`. | ||
|
||
![Creating repo from a template step 2](./assets/template-step-2.png) | ||
|
||
После того как репозиторий будет создан, необходимо перейти в настройки | ||
созданного репозитория на вкладку `Settings` > `Actions` > `General` как | ||
показано на изображении. | ||
|
||
![Settings GitHub Actions permissions step 1](./assets/gh-actions-perm-1.png) | ||
|
||
Проскролив страницу до самого конца, в секции `«Workflow permissions»` выбери | ||
опцию `«Read and write permissions»` и поставь галочку в чекбоксе. Это | ||
необходимо для автоматизации процесса деплоя проекта. | ||
|
||
![Settings GitHub Actions permissions step 2](./assets/gh-actions-perm-2.png) | ||
|
||
Теперь у тебя есть личный репозиторий проекта, со структурой файлов и папок | ||
репозитория-шаблона. Далее работай с ним как с любым другим личным репозиторием, | ||
клонируй его себе на компьютер, пиши код, делай коммиты и отправляй их на | ||
GitHub. | ||
|
||
## Подготовка к работе | ||
|
||
1. Убедись что на компьютере установлена LTS-версия Node.js. | ||
[Скачай и установи](https://nodejs.org/en/) её если необходимо. | ||
2. Установи базовые зависимости проекта командой `npm install`. | ||
3. Запусти режим разработки, выполнив команду `npm start`. | ||
4. Перейди в браузере по адресу [http://localhost:3000](http://localhost:3000). | ||
Эта страница будет автоматически перезагружаться после сохранения изменений в | ||
файлах проекта. | ||
|
||
## Деплой | ||
|
||
Продакшн версия проекта будет автоматически проходить линтинг, собираться и | ||
деплоиться на GitHub Pages, в ветку `gh-pages`, каждый раз когда обновляется | ||
ветка `main`. Например, после прямого пуша или принятого пул-реквеста. Для этого | ||
необходимо в файле `package.json` отредактировать поле `homepage`, заменив | ||
`your_username` и `your_repo_name` на свои, и отправить изменения на GitHub. | ||
|
||
```json | ||
"homepage": "https://your_username.github.io/your_repo_name/" | ||
``` | ||
|
||
Далее необходимо зайти в настройки GitHub-репозитория (`Settings` > `Pages`) и | ||
выставить раздачу продакшн версии файлов из папки `/root` ветки `gh-pages`, если | ||
это небыло сделано автоматически. | ||
|
||
![GitHub Pages settings](./assets/repo-settings.png) | ||
|
||
### Статус деплоя | ||
|
||
Статус деплоя крайнего коммита отображается иконкой возле его идентификатора. | ||
|
||
- **Желтый цвет** - выполняется сборка и деплой проекта. | ||
- **Зеленый цвет** - деплой завершился успешно. | ||
- **Красный цвет** - во время линтинга, сборки или деплоя произошла ошибка. | ||
|
||
Более детальную информацию о статусе можно посмотреть кликнув по иконке, и в | ||
выпадающем окне перейти по ссылке `Details`. | ||
|
||
![Deployment status](./assets/deploy-status.png) | ||
|
||
### Живая страница | ||
|
||
Через какое-то время, обычно пару минут, живую страницу можно будет посмотреть | ||
по адресу указанному в отредактированном свойстве `homepage`. Например, вот | ||
ссылка на живую версию для этого репозитория | ||
[https://goitacademy.github.io/react-homework-template](https://goitacademy.github.io/react-homework-template). | ||
|
||
Если открывается пустая страница, убедись что во вкладке `Console` нет ошибок | ||
связанных с неправильными путями к CSS и JS файлам проекта (**404**). Скорее | ||
всего у тебя неправильное значение свойства `homepage` в файле `package.json`. | ||
|
||
### Маршрутизация | ||
|
||
Если приложение использует библиотеку `react-router-dom` для маршрутизации, | ||
необходимо дополнительно настроить компонент `<BrowserRouter>`, передав в пропе | ||
`basename` точное название твоего репозитория. Слеш в начале строки обязателен. | ||
|
||
```jsx | ||
<BrowserRouter basename="/your_repo_name"> | ||
<App /> | ||
</BrowserRouter> | ||
``` | ||
|
||
## Как это работает | ||
|
||
![How it works](./assets/how-it-works.png) | ||
|
||
1. После каждого пуша в ветку `main` GitHub-репозитория, запускается специальный | ||
скрипт (GitHub Action) из файла `.github/workflows/deploy.yml`. | ||
2. Все файлы репозитория копируются на сервер, где проект инициализируется и | ||
проходит линтинг и сборку перед деплоем. | ||
3. Если все шаги прошли успешно, собранная продакшн версия файлов проекта | ||
отправляется в ветку `gh-pages`. В противном случае, в логе выполнения | ||
скрипта будет указано в чем проблема. | ||
Критерії прийому | ||
Використовуй цей шаблон React-проекту як стартову точку своєї програми. | ||
|
||
Створено репозиторій goit-react-hw-08-phonebook | ||
При здачі домашньої роботи є посилання на вихідні файли та робочі сторінки кожного проекту на GitHub Pages | ||
При запуску коду завдання, в консолі немає помилок та попереджень | ||
Для кожного компонента є окрема папка з файлом компонента React та файлом стилів | ||
Для компонентів описано propTypes | ||
Книга контактів | ||
Додай у програму «Книга контактів» можливість реєстрації, логіна та оновлення користувача, а також роботу з приватною колекцією контактів. | ||
|
||
Бекенд | ||
Для цього завдання є готовий бекенд. Ознайомся з документацією. Він підтримує всі необхідні операції з колекцією контактів, а також реєстрацію, логін та оновлення користувача за допомогою JWT. Використовуй його замість твого бекенда створеного через сервіс mockapi.io. | ||
|
||
Маршрутизація | ||
Додай маршрутизацію з бібліотекою React Router. У програмі має бути кілька сторінок: | ||
|
||
/register - публічний маршрут реєстрації нового користувача з формою | ||
/login - публічний маршрут логіна існуючого користувача з формою | ||
/contacts - приватний маршрут для роботи зі списком контактів користувача | ||
Додай компонент навігації Navigation з посиланнями для переходу по маршрутах. | ||
|
||
Меню користувача | ||
Створи компонент UserMenu, що відображає пошту користувача і кнопку виходу з облікового запису. Ось як може виглядати його розмітка. | ||
|
||
<div> | ||
<p>[email protected]</p> | ||
<button>Logout</button> | ||
</div> | ||
|
||
Стилізація | ||
Це фінальна версія програми, тому попрацюй над оформленням інтерфейсу. Можна використовувати бібліотеку стилізації або компонентів, наприклад Chakra UI або Material UI. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters