Skip to content

Commit

Permalink
add pre-commit info in ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
KonstantinRaikhert committed Aug 6, 2024
1 parent 63da777 commit e7bb8a2
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 20 deletions.
33 changes: 25 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ CMS для управления пользователями и расписан
export PATH="$HOME/.pyenv/bin:$PATH"
eval "$(pyenv init --path)"
```
Эти строки должны работать в большинстве случаев, если же что-то пошло не так -
Эти строки должны работать в большинстве случаев, если же что-то пошло не так -
почитайте документацию.
Перезапустите ваш терминал, либо выполните команду в терминале(если используете bash)
```
Expand Down Expand Up @@ -228,7 +228,24 @@ CMS для управления пользователями и расписан
RUN_BOT=false <-- для локального запуска значение должно быть false
```

8. Установите mkcert
8. Pre-commit (инструмент автоматического запуска различных проверок перед выполнением коммита):

- Убедиться, что pre-comit установлен:

```
pre-commit --version
```

- Настроить git hook скрипт:

```
pre-commit install
```

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

9. Установите mkcert
```
sudo apt install mkcert
```
Expand All @@ -238,7 +255,7 @@ CMS для управления пользователями и расписан
```
Если терминал ответил '1.4.3'(цифры могут отличаться), то всё сделано верно.

9. Установите сертификаты. Из корневой директории проекта
10. Установите сертификаты. Из корневой директории проекта
```
make create-ssl
```
Expand All @@ -253,15 +270,15 @@ CMS для управления пользователями и расписан
Также в директории Goodstart_telegram_bot/infra/dev/ должны появится файлы
cert.pem и key.pem. Если всё так, то можно переходить к следующему шагу.

10. Разверните проект. Из корневой директории проекта выполните команды
11. Разверните проект. Из корневой директории проекта выполните команды
```
make start-db
```
Дождитесь сборки контейнера. Далее введите команду
```
make init-app
```
Дождитесь окончания всех процедур. Должны выполниться миграции и создаться
Дождитесь окончания всех процедур. Должны выполниться миграции и создаться
superuser. Далее введите команду
```
make run-dev
Expand All @@ -285,7 +302,7 @@ CMS для управления пользователями и расписан
2024-06-25 22:29:33.325 | INFO | bot.bot_interface:_start_bot:104 - Bot is running.
```

11. Проверьте работоспособность проекта. В браузере перейдите по адресу
12. Проверьте работоспособность проекта. В браузере перейдите по адресу
```
https://localhost:8000/admin/
```
Expand Down Expand Up @@ -343,7 +360,7 @@ https://www.youtube.com/watch?v=_ifWi-a1z6M&ab_channel=AntonMaistrenko

## Деплой на сервер
1. Создать на сервере папку /home/username/Goodstart_telegram_bot
2. В папку Goodstart_telegram_bot положить:
2. В папку Goodstart_telegram_bot положить:
- заполненый файл .env (см. .env.example)
- файл docker-compose.dev.yaml
- папку infra\dev (с сохранением иерархии)
Expand All @@ -361,4 +378,4 @@ sudo docker compose -f docker-compose.dev.yaml exec backend export RUN_BOT=false
sudo docker compose -f docker-compose.dev.yaml exec backend python manage.py createsuperuser
```
## Настройка CD
В настройках репозитория (settings->secrets and variables->Actions->Repository secrets) настроить все переменные из .env.example
В настройках репозитория (settings->secrets and variables->Actions->Repository secrets) настроить все переменные из .env.example
24 changes: 12 additions & 12 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit e7bb8a2

Please sign in to comment.