From fc3ad9f6db2cd490b07594bb17de8d27f9c3a930 Mon Sep 17 00:00:00 2001 From: sokol Date: Fri, 20 Feb 2026 20:55:05 +0300 Subject: [PATCH] Add project structure: backend, frontend, shared folders --- .gitattributes | 3 +++ README.md | 36 ++++++++++++++++++++++++++++++++++++ backend/README.md | 36 ++++++++++++++++++++++++++++++++++++ frontend/README.md | 39 +++++++++++++++++++++++++++++++++++++++ shared/README.md | 18 ++++++++++++++++++ 5 files changed, 132 insertions(+) create mode 100644 .gitattributes create mode 100644 README.md create mode 100644 backend/README.md create mode 100644 frontend/README.md create mode 100644 shared/README.md diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..72bb96b --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +# Git + +.gitignore diff --git a/README.md b/README.md new file mode 100644 index 0000000..1276d68 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# MyBiz - Экономический симулятор + +## Структура проекта + +``` +my-game/ +├── backend/ # C# + Akka.net +├── frontend/ # Godot 4+ +├── shared/ # Общие компоненты +├── docs/ # Документация +└── tools/ # Утилиты +``` + +## Быстрый старт + +### Бэкенд + +```bash +cd backend +dotnet build +dotnet test +``` + +### Фронтенд + +1. Открыть Godot 4+ +2. Указать путь к `frontend/` +3. Запустить проект + +## Документация + +См. [docs/TZ.md](docs/TZ.md) - техническое задание проекта. + +## Лицензия + +[TBD] diff --git a/backend/README.md b/backend/README.md new file mode 100644 index 0000000..c8bfcd8 --- /dev/null +++ b/backend/README.md @@ -0,0 +1,36 @@ +# Backend - Экономический симулятор + +Бэкенд на C# + Akka.net для экономического симулятора. + +## Структура + +``` +backend/ +├── src/ +│ ├── MyBiz.Core/ # Ядро: модели, интерфейсы +│ ├── MyBiz.Economy/ # Экономическая модель +│ ├── MyBiz.Production/ # Производство, цепочки +│ ├── MyBiz.Trade/ # Торговля, рынки +│ ├── MyBiz.Research/ # Исследования, tech tree +│ ├── MyBiz.Infrastructure/# Актеры, менеджеры +│ └── MyBiz.API/ # API для фронтенда +└── tests/ + ├── MyBiz.Core.Tests/ + ├── MyBiz.Economy.Tests/ + └── ... +``` + +## Технологии + +- .NET 8 +- Akka.net (акторная модель) +- xUnit (тесты) +- SQLite (хранение состояния) + +## Запуск + +```bash +cd backend +dotnet build +dotnet test +``` diff --git a/frontend/README.md b/frontend/README.md new file mode 100644 index 0000000..e5550c5 --- /dev/null +++ b/frontend/README.md @@ -0,0 +1,39 @@ +# Frontend - Экономический симулятор + +Фронтенд на Godot 4+ для экономического симулятора. + +## Структура + +``` +frontend/ +├── scenes/ # Godot сцены +│ ├── main/ # Главная сцена +│ ├── ui/ # UI компоненты +│ ├── map/ # Карта, города +│ └── buildings/ # Здания +├── scripts/ # C# скрипты +│ ├── core/ # Ядро +│ ├── economy/ # Экономика +│ ├── ui/ # UI логика +│ └── services/ # Сервисы (сеть, сохранения) +├── assets/ # Ресурсы +│ ├── sprites/ # 2D спрайты +│ ├── models/ # 3D модели (если нужно) +│ ├── audio/ # Звуки, музыка +│ └── fonts/ # Шрифты +└── resources/ # Godot ресурсы + ├── data/ # Данные (товары, здания) + └── localization/ # Локализация +``` + +## Технологии + +- Godot 4+ +- C# (.NET 8) +- Изометрическая псевдо-3D графика + +## Запуск + +1. Открыть Godot +2. Указать путь к `frontend/` +3. Запустить проект diff --git a/shared/README.md b/shared/README.md new file mode 100644 index 0000000..bc68d9b --- /dev/null +++ b/shared/README.md @@ -0,0 +1,18 @@ +# Shared - Общие компоненты + +Общие модели, контракты и утилиты для бэкенда и фронтенда. + +## Структура + +``` +shared/ +├── models/ # Общие модели данных +├── contracts/ # Контракты API +└── utils/ # Утилиты +``` + +## Назначение + +- Общие DTO для клиент-серверного взаимодействия +- Сериализация/десериализация +- Константы, перечисления