README is updated

smirnovlad · Dec 30, 2023 · 64e8b17 · 64e8b17
1 parent 973d94a
commit 64e8b17
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 7 deletions.
diff --git a/.github/workflows/docker-compose.yml → .github/workflows/test_and_deploy.yml b/.github/workflows/docker-compose.yml → .github/workflows/test_and_deploy.yml
@@ -1,4 +1,4 @@
-name: Deploy to remote server
+name: Test app and deploy to remote server
 
 on:
   push:

diff --git a/README.md b/README.md
@@ -38,6 +38,10 @@
 - http://158.160.113.82/users
 - http://158.160.113.82/feedback
 
+## CI/CD
+
+При пуше и пул-реквесте в главную ветку триггерится workflow, который включает в себя тестирование приложения с последующим деплоем на удалённый сервер в случае успеха. Для базы данных выделяется отдельный volume, вследствие чего при очередном обновлении её состояние остаётся актуальным (не сбрасывается).
+
 ## How to build
 ### Locally
 Для начала необходимо обновить константы в `backend/backend/settings.py` и `react-app/src/api/config.js`, соответствующие хосту и портам.
@@ -125,9 +129,8 @@ docker system prune -a --volumes
 
 ## TODO
 
-1. Добавить тесты
-2. Добавить поддержку авторизации пользователя по номеру телефона
-3. Перейти на JWT-токены
-4. Добавить криптографические зависимости
-5. Добавить поддержку SEO
-6. Нотификация о сообщениях вне чата
+1. Придумать более комплексные тесты (запросы на удалённый сервер, аутентефикация и т.д.)
+2. Перейти на JWT-токены
+3. Добавить криптографические зависимости
+4. Добавить поддержку SEO
+5. Нотификация о сообщениях вне чата