docs: update documentation to reflect new project structure

- Update README.md with new project structure and installation instructions
- Update docs/installation.md with simplified setup process
- Update docs/configuration.md with correct file paths
- Update docs/index.md with new documentation structure
- Add docs/project-structure.md with detailed architecture overview
- Reflect changes from refactoring: app/ directory structure, .env file usage
- Update installation instructions to use docker compose up --build -d
- Add comprehensive project structure documentation
This commit is contained in:
Сергей Антропов
2025-08-20 18:32:31 +03:00
parent ab4c2924c3
commit c40b2b312e
5 changed files with 257 additions and 30 deletions

View File

@@ -40,10 +40,10 @@ git clone <repository-url>
cd logboard
# Настройка переменных окружения
make setup
cp env.example .env
# Запуск приложения
make up
docker compose up --build -d
```
### Доступ
@@ -62,31 +62,37 @@ make up
- Настройка для продакшена
- Устранение проблем установки
2. **[API Документация](./api.md)**
2. **[Структура проекта](./project-structure.md)**
- Архитектура приложения
- Описание модулей
- Принципы организации
- Добавление новых модулей
3. **[API Документация](./api.md)**
- REST API endpoints
- WebSocket API
- Примеры использования
- Коды ошибок
3. **[WebSocket API](./websocket.md)**
4. **[WebSocket API](./websocket.md)**
- Подключение к WebSocket
- Real-time логи
- Обработка ошибок
- Лучшие практики
4. **[Конфигурация](./configuration.md)**
5. **[Конфигурация](./configuration.md)**
- Переменные окружения
- Настройка Docker
- Настройка безопасности
- Примеры конфигураций
5. **[Безопасность](./security.md)**
6. **[Безопасность](./security.md)**
- Генерация ключей
- Аутентификация
- Настройка HTTPS
- Мониторинг безопасности
6. **[Устранение неполадок](./troubleshooting.md)**
7. **[Устранение неполадок](./troubleshooting.md)**
- Общие проблемы
- Проблемы с Docker
- Проблемы с аутентификацией