From bae986d3fee25642e2028c017d559131ccff85c6 Mon Sep 17 00:00:00 2001 From: InsanusMokrassar Date: Sat, 8 Jan 2022 18:20:08 +0600 Subject: [PATCH] add note about services --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 060faacc..a6e7f9e4 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ ## Структура проекта -* Features - набор **законченных** фич проекта. Считается, что любая фича, находящаяся в мастере может быть добавлена в +* **Features** - набор **законченных** фич проекта. Считается, что любая фича, находящаяся в мастере может быть добавлена в клиент и использована в нем. Исключением является `common` - это набор вещей, используемых везде. В подпунктах представлены части, на которые *обычно* разделяется фича * Common - общая для фичи часть. Тут, как правило, хранятся конвенции путей для сетевых соединений, общие типы и пр. * Server - часть, включаемая в сервер для подключения фичи. Обычно содержит работу с бд, определение модулей сервера и пр. * Client - часть с клиентским кодом. В большинстве своём включает работу с сервером, MVVM часть (View при этом должны находиться в платформенной части, если их нельзя вынести в сommon часть клиента) -* Client - итоговый клиент. На момент написания этой доки (`Пн окт 25 12:56:41 +06 2021`) предполагается два варианта: +* **Services** - модули, отвечающие за клиент-серверную работу фич с точки зрения их взаимодействия. Например, в рамках сервисов + должен быть добавлен модуль для постов - именно через сервисы будет происходить создание поста, его редактирование и удаление +* **Client** - итоговый клиент. На момент написания этой доки (`Пн окт 25 12:56:41 +06 2021`) предполагается два варианта: * Мультиплатформенный проект со сборкой каждого таргета. Скорее всего, не будет использован в силу сложности настройки части клиентов (например, андроид) * Мультимодульный проект -* Server - пока что JVM-only модуль, включающий все необходимые для сервера фичи +* **Server** - пока что JVM-only модуль, включающий все необходимые для сервера фичи