Создание документации

This commit is contained in:
2025-06-01 19:57:59 +04:00
parent 8ff9f6bbc6
commit c9c92a2b54
1222 changed files with 21314 additions and 74 deletions
+9 -2
View File
@@ -8,8 +8,9 @@
- Создайте файл `.env` и добавьте в него содержимое из файла `.env.example`. Измените содержащиеся поля:
- `DATA_DIR` - путь к папке для распаковки репозиториев обрабатываемых данных;
- `OUTPUT_DIR` - путь к месту сохранения схем;
- `DATABASE_CONNECTION` - строка подключения к БД (только PostreSQL).
- Перейдите а папку `Pf2eModel` (`cd ../Pf2eModel`) и запустите `dotnet ef database update` для создания структуры БД в командной строке.
- `DATABASE_CONNECTION` - строка подключения к БД (только PostreSQL);
- `MAX_THREADS` - максимальное количество потоков при параллельной обработке.
- Перейдите а папку `Pf2eModel` (`cd ../Pf2eModel`) и запустите `dotnet ef database update` для создания структуры БД в командной строке. Если необходимо обновить структуру после изменения модели - используйте скрипт `RebuildDatabase.bat`.
- Запустите проект `Pf2eDataScrapper` для парсинга информации.
## Роли проектов
@@ -39,6 +40,12 @@
### `Pf2eDataScrapper`
Основной проект обработки и отображения данных.
Структура пространст имён:
- `Helpers` - классы-помощники, которые используются в
#### `SchemaBuilder`
Классы обработки вводимых JSON-данных и создание схемы данных для использовании при формировании обработчиков данных.