mnemo_cards/README.md

61 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2025-11-16 13:54:50 +00:00
# Mnemo Cards
Проект для изучения языков с использованием мнемоники.
## Структура проекта
- `mnemo_cards/` - мобильное приложение (Flutter)
- `mnemo_cards_web_v2/` - веб версия (Flutter Web)
- `mnemo_cards_backend/` - backend сервер (Dart)
- `mnemo_cards_common/` - общие библиотеки
- `@tools/` - инструменты разработки и деплоя
## Быстрый старт
### Разработка
2025-11-10 23:55:41 +00:00
```bash
2025-11-16 13:54:50 +00:00
# Установка зависимостей
2025-11-10 23:55:41 +00:00
flutter pub get
2025-11-16 13:54:50 +00:00
# Запуск веб версии
cd mnemo_cards_web_v2
2025-11-10 23:55:41 +00:00
flutter run -d chrome
2025-11-16 13:54:50 +00:00
# Запуск backend
2025-11-10 23:55:41 +00:00
cd mnemo_cards_backend
2025-11-16 13:54:50 +00:00
dart run bin/server.dart
2025-11-10 23:55:41 +00:00
```
2025-11-16 13:54:50 +00:00
### Деплой
2025-11-10 23:55:41 +00:00
```bash
2025-11-16 13:54:50 +00:00
# Проверка готовности к деплою
tools/scripts/check_deploy_ready.sh
2025-11-10 23:55:41 +00:00
2025-11-16 13:54:50 +00:00
# Локальное тестирование CI/CD
tools/scripts/test_ci_locally.sh
2025-11-10 23:55:41 +00:00
2025-11-16 13:54:50 +00:00
# Запуск деплоя
git push origin main
2025-11-10 23:55:41 +00:00
```
2025-11-16 13:54:50 +00:00
## Документация
- [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
```