61 lines
No EOL
1.9 KiB
Markdown
61 lines
No EOL
1.9 KiB
Markdown
# Mnemo Cards
|
||
|
||
Проект для изучения языков с использованием мнемоники.
|
||
|
||
## Структура проекта
|
||
|
||
- `mnemo_cards/` - мобильное приложение (Flutter)
|
||
- `mnemo_cards_web_v2/` - веб версия (Flutter Web)
|
||
- `mnemo_cards_backend/` - backend сервер (Dart)
|
||
- `mnemo_cards_common/` - общие библиотеки
|
||
- `@tools/` - инструменты разработки и деплоя
|
||
|
||
## Быстрый старт
|
||
|
||
### Разработка
|
||
|
||
```bash
|
||
# Установка зависимостей
|
||
flutter pub get
|
||
|
||
# Запуск веб версии
|
||
cd mnemo_cards_web_v2
|
||
flutter run -d chrome
|
||
|
||
# Запуск backend
|
||
cd mnemo_cards_backend
|
||
dart run bin/server.dart
|
||
```
|
||
|
||
### Деплой
|
||
|
||
```bash
|
||
# Проверка готовности к деплою
|
||
tools/scripts/check_deploy_ready.sh
|
||
|
||
# Локальное тестирование CI/CD
|
||
tools/scripts/test_ci_locally.sh
|
||
|
||
# Запуск деплоя
|
||
git push origin main
|
||
```
|
||
|
||
## Документация
|
||
|
||
- [CI/CD Setup](tools/docs/CI_CD_SETUP.md) - настройка автоматического деплоя
|
||
- [Web App](mnemo_cards_web_v2/README.md) - документация веб версии
|
||
- [Backend](mnemo_cards_backend/README.md) - документация backend
|
||
|
||
## Структура tools/
|
||
|
||
```
|
||
tools/
|
||
├── ci/ # CI/CD workflows для Forgejo
|
||
├── deploy/ # Скрипты деплоя
|
||
│ ├── backend-build_app.sh # Сборка backend
|
||
│ └── web-app/ # Скрипты деплоя веб приложения
|
||
├── docs/ # Документация
|
||
└── scripts/ # Вспомогательные скрипты
|
||
├── check_deploy_ready.sh # Проверка готовности деплоя
|
||
└── test_ci_locally.sh # Локальное тестирование CI/CD
|
||
``` |