docs: rewrite README with full project overview
- Add project description, roles, test format - Add tech stack table - Add sprint plan summary - Add documentation index - Add quick start command Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -1,3 +1,70 @@
|
||||
# qa_test_app
|
||||
# QA Test App — Система тестирования сотрудников клиники
|
||||
|
||||
Приложение для тестирования сотрудников клиники методом один вопрос - до пяти ответов один из которых правильный. Сотрудник должен выбрать правильный вариант ответа
|
||||
Веб-приложение для проведения внутреннего тестирования сотрудников. Руководители подразделений создают тесты, назначают их сотрудникам, система фиксирует результаты.
|
||||
|
||||
> Проект разрабатывается как **мастер-класс для джуниор-разработчиков**. История разработки — пошаговые запросы и решения — сохраняется в `DOC/ШАГИ/`.
|
||||
|
||||
---
|
||||
|
||||
## Формат тестирования
|
||||
|
||||
- Вопрос + минимум 3 варианта ответа (один или несколько правильных)
|
||||
- Минимум 7 вопросов в тесте
|
||||
- Случайный порядок вопросов при каждом прохождении
|
||||
- Опциональный таймер на прохождение
|
||||
- Порог зачёта задаётся автором теста (%)
|
||||
|
||||
---
|
||||
|
||||
## Роли
|
||||
|
||||
| Роль | Возможности |
|
||||
|------|------------|
|
||||
| **HR-менеджер / Директор** | Создаёт тесты, назначает всем сотрудникам клиники, видит все результаты |
|
||||
| **Руководитель подразделения** | Создаёт тесты, назначает только своему отделу, видит результаты своего отдела |
|
||||
| **Сотрудник** | Проходит назначенные тесты, видит свои результаты и ошибки |
|
||||
|
||||
---
|
||||
|
||||
## Стек
|
||||
|
||||
| Слой | Технология |
|
||||
|------|-----------|
|
||||
| Backend | Python 3.12 + FastAPI + SQLAlchemy 2.0 + Alembic |
|
||||
| База данных | PostgreSQL 16 |
|
||||
| Frontend | React 18 + TypeScript + Vite + Ant Design + TanStack Query |
|
||||
| Инфраструктура | Docker Compose + Nginx |
|
||||
| Уведомления | Мессенджер MAX (Спринт 5) |
|
||||
|
||||
---
|
||||
|
||||
## План спринтов
|
||||
|
||||
| Спринт | Содержание |
|
||||
|--------|-----------|
|
||||
| **1** | Инфраструктура (Docker, FastAPI, React, PostgreSQL) + создание тестов |
|
||||
| **2** | Прохождение теста + результаты и разбор ошибок |
|
||||
| **3** | Трекер результатов |
|
||||
| **4** | Авторизация, роли, подразделения, управление пользователями |
|
||||
| **5** | Уведомления в MAX |
|
||||
|
||||
---
|
||||
|
||||
## Документация
|
||||
|
||||
| Файл | Содержание |
|
||||
|------|-----------|
|
||||
| `DOC/ТЗ.md` | Техническое задание (v1.1) |
|
||||
| `DOC/СТЕК.md` | Технологический стек с обоснованием |
|
||||
| `DOC/СПРИНТЫ.md` | Детальный план спринтов с задачами |
|
||||
| `DOC/ШАГИ/` | История разработки шаг за шагом |
|
||||
|
||||
---
|
||||
|
||||
## Запуск (после Спринта 1)
|
||||
|
||||
```bash
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
Приложение будет доступно на `http://localhost`.
|
||||
|
||||
Reference in New Issue
Block a user