add basic readme and add new data to get complation results endpoint

2026-05-22 20:57:09 +00:00 · 2025-03-03 19:28:58 +03:00
parent a0d2892fe0
commit 4770af7cc7
4 changed files with 43 additions and 3 deletions
@@ -1 +1,33 @@
 # DataRush
+
+Инновационный сервис для проведения соревнований по анализу данных
+
+
+## Запуск
+
+Склонируйте репозиторий и пропишите 
+
+```bash
+docker compose up
+```
+
+## Основные ручки
+
+* `/` - основное приложение
+* `/api/v1/docs` - swagger-ui документация
+* `/admin` - админка
+* `/admin/grafana` - графана
+* `/docs` - гайд по анализу данных
+
+После запуска по методу выше создается пользователь в админке (`/admin`) с данными ниже:`admin` 
+- `admin` - логин
+- `proooooood` - пароль
+
+
+## Тесты
+
+Написаны unit-тесты (на базе Django TestCase) и E2E (Postman коллекция)
+
+![Postman data](img/postman.gif)
+
+![django test]()