feat: readme
This commit is contained in:
45
README.md
Normal file
45
README.md
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
## LCT2025 — Эспада (Alabuga)
|
||||||
|
|
||||||
|
Команда:
|
||||||
|
- **Тимлид:** Дорошко Максим Игоревич
|
||||||
|
- **Бекенд:** Папин Николай Алексеевич, Хлынин Роман Олегович
|
||||||
|
- **Фронтенд:** Шевченко Рудольф Дмитриевич
|
||||||
|
- **Дизайн:** Кривошеева Екатерина Валерьевна
|
||||||
|
|
||||||
|
## Архитектура
|
||||||
|
Монолитное веб-приложение с REST API. Основные технологии:
|
||||||
|
- фронтенд: Next.js
|
||||||
|
- бекенд: C# (.NET 9 / ASP.NET 9)
|
||||||
|
- база данных: PostgreSQL
|
||||||
|
- хранилище объектов: MinIO (S3-совместимое)
|
||||||
|
- кеш/очереди: Redis
|
||||||
|
|
||||||
|
Развёртывание и оркестрация через docker compose.
|
||||||
|
|
||||||
|
## Реализованные механики
|
||||||
|
- магазин — покупка предметов
|
||||||
|
- инвентарь — хранение купленных/полученных предметов или артефактов
|
||||||
|
- система уровней навыков
|
||||||
|
- ранги — ранги пользователей влияют на доступность миссий и предметов в магазине
|
||||||
|
- пути развития миссий — ветвящиеся миссии/прогресс
|
||||||
|
- REST CRUD для основных сущностей (пользователь, миссия, предмет) со стороны API
|
||||||
|
- интеграция с MinIO и Redis для хранения и кеширования
|
||||||
|
|
||||||
|
## Что не реализовано и почему
|
||||||
|
- полная микроcервисная декомпозиция — проект сделан монолитом из-за ограничений времени и объёма работ
|
||||||
|
|
||||||
|
## Инструкция по запуску (локально)
|
||||||
|
1. Клонировать репозиторий:
|
||||||
|
```
|
||||||
|
git clone https://github.com/EspadaKomanda/lct2025-monlith
|
||||||
|
cd lct2025-monolith
|
||||||
|
```
|
||||||
|
2. Запустить сервисы через Docker Compose:
|
||||||
|
```
|
||||||
|
docker compose up
|
||||||
|
```
|
||||||
|
3. Открыть сайт в браузере:
|
||||||
|
- http://localhost:3000
|
||||||
|
|
||||||
|
## Ссылки
|
||||||
|
- Репозиторий: https://github.com/EspadaKomanda/lct2025-monlith
|
||||||
Reference in New Issue
Block a user