diff --git a/README.md b/README.md index accd652..8f4757a 100644 --- a/README.md +++ b/README.md @@ -61,3 +61,35 @@ Friflex Starter - это стартовый шаблон для разработ ## Начало работы Для начала работы с проектом рекомендуется ознакомиться с документацией в директории `/tools/rfc/`, особенно с инструкциями по запуску проекта и стилем написания кода. + +## Рекомендованный 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) + +## Стиль написания кода + - [Стиль написания кода](./tools/rfc/RFC-codestyle.md) + +## Внесение изменений в код + - [Внесение изменений в код](./tools/rfc/RFC-gitflow.md) + +## Структура проекта + - [Структура проекта](./tools/rfc/RFC-projects_structure.md) + +## Ведение документации и комментариев в проекте + - [Ведение документации и комментариев в проекте](./tools/rfc/RFC-documentation.md) diff --git a/tools/rfc/RFC_readme.md b/tools/rfc/RFC_readme.md deleted file mode 100644 index 4abce8a..0000000 --- a/tools/rfc/RFC_readme.md +++ /dev/null @@ -1,30 +0,0 @@ -#### Приложение [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) - -## Стиль написания кода - - [Стиль написания кода](./tools/rfc/RFC-codestyle.md) - -## Внесение изменений в код - - [Внесение изменений в код](./tools/rfc/RFC-gitflow.md) - -## Структура проекта - - [Структура проекта](./tools/rfc/RFC-projects_structure.md) - -## Ведение документации и комментариев в проекте - - [Ведение документации и комментариев в проекте](./tools/rfc/RFC-documentation.md)