Docs: начальная структура проекта Управление ИТ (ОМС)

Made-with: Cursor

README.md

@@ -0,0 +1,57 @@
+# Управление ИТ (ОМС) — система дистанционного обучения
+
+Система дистанционного обучения с фиксацией прохождения обучения и результатов тестирования сотрудников.
+
+## Назначение
+
+- Раздача контента обучения и тестирования (HTML).
+- Фиксация ФИО сотрудника при старте обучения и при прохождении теста.
+- Сохранение результатов тестирования в базе данных.
+
+## Требования и зависимости
+
+- Docker, Docker Compose
+- (Планируется) PostgreSQL для хранения записей о прохождении и результатах тестов
+
+## Установка и настройка
+
+1. Скопировать `.env.example` в `.env` и при необходимости задать переменные.
+2. Запуск: `docker compose up -d` (после добавления серверной части).
+
+## Конфигурация
+
+См. `.env.example`. Переменные задаются в `.env` (файл не коммитится).
+
+## Структура проекта
+
+```
+/opt/lms-it-oms/
+├── README.md
+├── HISTORY.md
+├── .env.example
+├── docker-compose.yml
+├── content/          # HTML-файлы обучения и тестирования (положить сюда для анализа)
+└── (backend/ и static/ — будут добавлены при реализации серверной части)
+```
+
+### Куда положить HTML для анализа
+
+**Положите ваши HTML-файлы обучения и тестирования в каталог:**
+
+```
+/opt/lms-it-oms/content/
+```
+
+После размещения файлов можно запросить анализ и корректировку контента, а затем — добавление серверной части для учёта ФИО и результатов тестов.
+
+## Логирование
+
+(Будет описано после внедрения серверной части.)
+
+## Резервное копирование
+
+Volumes проекта будут добавлены в `/opt/gen7x/backup/include-volumes.txt`.
+
+## История изменений
+
+См. [HISTORY.md](HISTORY.md).