Files
quoter/docs/README.md

40 lines
2.2 KiB
Markdown
Raw Normal View History

2025-08-02 00:18:09 +03:00
# Документация Quoter
## 📚 Оглавление
### Основные разделы
- [Как это работает](./how-it-works.md) - Подробное описание архитектуры и процессов
- [API Reference](./api-reference.md) - Полная документация API
- [Развертывание](./deployment.md) - Инструкции по развертыванию
- [Конфигурация](./configuration.md) - Настройка переменных окружения
- [Мониторинг](./monitoring.md) - Логирование и мониторинг
### Технические детали
- [Архитектура](./architecture.md) - Техническая архитектура системы
- [База данных](./database.md) - Структура Redis и схемы данных
- [S3 интеграция](./s3-integration.md) - Работа с S3/Storj
- [Обработка изображений](./image-processing.md) - Создание миниатюр и оверлеев
- [Безопасность](./security.md) - Аутентификация и авторизация
### Разработка
- [Разработка](./development.md) - Настройка среды разработки
- [Тестирование](./testing.md) - Руководство по тестированию
- [Contributing](./contributing.md) - Руководство для контрибьюторов
2025-08-12 15:59:51 +03:00
### CI/CD и автоматизация
- [Тестирование](./testing.md) - Полное покрытие тестами (36 тестов)
- [Развертывание](./deployment.md) - Автоматизированный конвейер
- [Мониторинг](./monitoring.md) - Отслеживание качества кода
2025-08-02 00:18:09 +03:00
## 🚀 Быстрый старт
1. Установите зависимости: `cargo build`
2. Настройте переменные окружения (см. [Конфигурация](./configuration.md))
3. Запустите сервер: `cargo run`
4. Проверьте API: `curl http://localhost:8080/`
## 📋 Требования
- Rust 1.70+
- Redis 6.0+
- Доступ к S3/Storj API