From 799252f6f506adfde338eff10e9436bcd6c69656 Mon Sep 17 00:00:00 2001 From: PetrovY Date: Sat, 7 Jun 2025 19:07:19 +0300 Subject: [PATCH] =?UTF-8?q?docs(readme):=20=D0=9E=D0=B1=D0=BD=D0=BE=D0=B2?= =?UTF-8?q?=D0=B8=D1=82=D1=8C=20README.md,=20=D0=B4=D0=BE=D0=B1=D0=B0?= =?UTF-8?q?=D0=B2=D0=B8=D0=B2=20=D1=80=D0=B5=D0=BA=D0=BE=D0=BC=D0=B5=D0=BD?= =?UTF-8?q?=D0=B4=D0=B0=D1=86=D0=B8=D0=B8=20=D0=BF=D0=BE=20=D1=81=D1=82?= =?UTF-8?q?=D1=80=D1=83=D0=BA=D1=82=D1=83=D1=80=D0=B5=20=D0=BF=D1=80=D0=BE?= =?UTF-8?q?=D0=B5=D0=BA=D1=82=D0=B0=20=D0=B8=20=D0=B8=D0=BD=D1=81=D1=82?= =?UTF-8?q?=D1=80=D1=83=D0=BA=D1=86=D0=B8=D0=B8.=20=D0=A3=D0=B4=D0=B0?= =?UTF-8?q?=D0=BB=D0=B5=D0=BD=20=D1=83=D1=81=D1=82=D0=B0=D1=80=D0=B5=D0=B2?= =?UTF-8?q?=D1=88=D0=B8=D0=B9=20=D1=84=D0=B0=D0=B9=D0=BB=20RFC=5Freadme.md?= =?UTF-8?q?.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 32 ++++++++++++++++++++++++++++++++ tools/rfc/RFC_readme.md | 30 ------------------------------ 2 files changed, 32 insertions(+), 30 deletions(-) delete mode 100644 tools/rfc/RFC_readme.md 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)