Update README.md to reflect project name change to "Alabuga Gamification Platform" and remove outdated sections on test data cleanup and leaderboard details.

This commit is contained in:
danilgryaznev 2025-09-28 21:08:45 +03:00
parent 252ae0b91c
commit f6e661ee60

View File

@ -1,4 +1,4 @@
# «Автостопом по Алабуге» # Alabuga Gamification Platform
Проект «Автостопом по Алабуге» — это геймифицированный гид по карьерной Галактике Алабуги. Как и в «Автостопом по Галактике», экипаж полагается на остроумные подсказки, лор и рейтинг пилотов, чтобы не потерять полотенце в бюрократических туманностях. Репозиторий содержит backend на FastAPI (Python 3.13) и фронтенд на Next.js (TypeScript). Проект «Автостопом по Алабуге» — это геймифицированный гид по карьерной Галактике Алабуги. Как и в «Автостопом по Галактике», экипаж полагается на остроумные подсказки, лор и рейтинг пилотов, чтобы не потерять полотенце в бюрократических туманностях. Репозиторий содержит backend на FastAPI (Python 3.13) и фронтенд на Next.js (TypeScript).
@ -54,7 +54,6 @@ Docker Compose автоматически переопределяет `ALABUGA_
6. **Выполнение миссии**: отправьте отчёт и документы, затем переключитесь на HR и одобрите выполнение — ранги, компетенции и мана обновятся автоматически. 6. **Выполнение миссии**: отправьте отчёт и документы, затем переключитесь на HR и одобрите выполнение — ранги, компетенции и мана обновятся автоматически.
7. **HR панель**: под HR-пользователем проверьте сводку, модерацию, редактирование веток/миссий/рангов, создание артефактов и аналитику (`/admin`). Для просмотра экрана кандидата используйте пункт «Просмотр от лица пилота» — он откроет `/` в режиме read-only и добавит кнопку «Вернуться к HR». 7. **HR панель**: под HR-пользователем проверьте сводку, модерацию, редактирование веток/миссий/рангов, создание артефактов и аналитику (`/admin`). Для просмотра экрана кандидата используйте пункт «Просмотр от лица пилота» — он откроет `/` в режиме read-only и добавит кнопку «Вернуться к HR».
8. **Магазин**: вернитесь к пилоту, оформите заказ в `/store` — запись появится в журнале и очереди HR; при недостатке маны интерфейс подскажет, что делать. 8. **Магазин**: вернитесь к пилоту, оформите заказ в `/store` — запись появится в журнале и очереди HR; при недостатке маны интерфейс подскажет, что делать.
9. **Лидерборд**: откройте `/leaderboard` (доступно и пилотам, и HR), чтобы увидеть текущие позиции по опыту и уровню компетенций.
### Подтверждение электронной почты ### Подтверждение электронной почты
@ -67,16 +66,6 @@ Docker Compose автоматически переопределяет `ALABUGA_
Демо-учётные записи в сид-данных имеют уже подтверждённый e-mail. Демо-учётные записи в сид-данных имеют уже подтверждённый e-mail.
### Очистка тестовых данных
Чтобы удалить отправленные миссии, журнал и вложения, выполните:
```bash
python -m scripts.reset_demo_data
```
Скрипт прогонит миграции, очистит таблицы `mission_submissions`, `orders`, `journal_entries`, сбросит опыт/ману пользователей и удалит весь каталог с загруженными документами (`ALABUGA_UPLOADS_PATH`).
## Тестирование ## Тестирование
```bash ```bash
@ -96,7 +85,6 @@ pytest
- Онбординг с сохранением прогресса и космическим лором. - Онбординг с сохранением прогресса и космическим лором.
- Таблица лидеров по опыту и мане за неделю/месяц/год. - Таблица лидеров по опыту и мане за неделю/месяц/год.
- Аналитическая сводка для HR: активность пилотов, очередь модерации, завершённость веток. - Аналитическая сводка для HR: активность пилотов, очередь модерации, завершённость веток.
- Лидерборд пилотов по опыту с отображением ключевых компетенций.
Админ-инструменты доступны на странице `/admin` (используйте демо-пользователя HR). Здесь можно: Админ-инструменты доступны на странице `/admin` (используйте демо-пользователя HR). Здесь можно: