mirror of
https://github.com/smmarty/friflex_flutter_starter.git
synced 2025-12-22 01:20:46 +00:00
31 lines
2.1 KiB
Markdown
31 lines
2.1 KiB
Markdown
## Рекомендованный Readme для проектов
|
||
#### Приложение [ProjectName]
|
||
|
||
## Структура проекта
|
||
- проект архитектурно делится на три слоя: data, domain и presentation;
|
||
- все [features] реализуются в отдельных папках, с внутренним делением на слои;
|
||
|
||
## Основные пакеты и реализации (обновляется при добавлении или изменении)
|
||
- управление роутингом: [go_router](https://pub.dev/packages/go_router);
|
||
- основной state manager: [flutter_bloc](https://pub.dev/packages/flutter_bloc);
|
||
- di: ручная реализация через InheritedWidget;
|
||
- работа с ресурсами: [flutter_gen](https://pub.dev/packages/flutter_gen);
|
||
- анализатор: используем [friflex_lint_rules](https://pub.friflex.com/packages/friflex_lint_rules), с правилами написания кода от компании.;
|
||
- для хранения защищенных данных - [flutter_secure_storage](https://pub.dev/packages/flutter_secure_storage);
|
||
- для хранения данных - [shared_preferences](https://pub.dev/packages/shared_preferences);
|
||
- для работы с API - [dio](https://pub.dev/packages/dio);
|
||
|
||
## Инструкция по запуску проекта
|
||
- [Инструкция по запуску проекта](./tools/rfc/RFC-build.md)
|
||
|
||
## Стиль написания кода
|
||
- [Стиль написания кода](./*ools*/rfc/RFC-codestyle.md)
|
||
|
||
## Внесение изменений в код
|
||
- [Внесение изменений в код](./tools/rfc/RFC-gitflow.md)
|
||
|
||
## Структура проекта
|
||
- [Структура проекта](./tools/rfc/RFC-projects_structure.md)
|
||
|
||
## Ведение документации и комментариев в проекте
|
||
- [Ведение документации и комментариев в проекте](./tools/rfc/RFC-documentation.md) |