From 115c3fa3aa5acf35b1732e4296bd58ec4634df44 Mon Sep 17 00:00:00 2001
From: Nikitin Aleksandr <nikitinav@atomsbt.ru>
Date: Fri, 22 Mar 2024 16:26:01 +0300
Subject: [PATCH] =?UTF-8?q?=D1=81=D0=B4=D0=B5=D0=BB=D0=B0=D0=BB=20README.m?=
 =?UTF-8?q?d?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 bin/templates/README.md  | 42 ++++++++++++++++++++++++++++++++++++++
 bin/templates/readme.rus | 44 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 86 insertions(+)
 create mode 100644 bin/templates/README.md
 create mode 100644 bin/templates/readme.rus

diff --git a/bin/templates/README.md b/bin/templates/README.md
new file mode 100644
index 0000000..d1d4f07
--- /dev/null
+++ b/bin/templates/README.md
@@ -0,0 +1,42 @@
+The service implements synchronous data exchange.
+
+Service for exchanging data with Postgres SQL database
+Data exchange is done using different methods:
+1. Commands in NATS for reading, changing, etc.
+2. DB CRUD operations - direct exchange with the database
+    (each table model has methods Read(), Update(), Create(), Save(), Delete(), Restore())
+3. GRPC - exchange with the database using the GRPC protocol
+    (the client service that needs to exchange with the database connects to the sync_exchange server service, the latter exchanges with the database)
+4. NRPC - exchange with the database using the NRPC protocol
+    (the client service that needs to exchange with the database connects to the NATS service, which sends commands to the sync_exchange server, the latter exchanges with the database)
+
+Before starting CRUD operations, you must specify the transport over which the exchange will take place (CRUD, GRPC, NRPC)
+using one of the commands:
+InitCrudTransport_DB()
+InitCrudTransport_GRPC()
+InitCrudTransport_NRPC()
+from module
+"gitlab.aescorp.ru/dsp_dev/claim/sync_service/pkg/crud_starter"
+
+Also, to get started, the environment variables must be filled in:
+
+1) for DB CRUD:
+    DB_HOST="10.1.9.23"
+    DB_NAME="claim"
+    DB_SCHEME="public"
+    DB_PORT="5432"
+    DB_USER=""
+    DB_PASSWORD=""
+
+2) for GRPC:
+    SYNC_SERVICE_HOST=10.1.9.150
+    SYNC_SERVICE_PORT=30031
+
+3) for NRPC:
+    BUS_LOCAL_HOST="10.1.9.150"
+    BUS_LOCAL_PORT=30222
+
+For NRPC (GRPC) it is advisable to connect there first and disconnect at the end
+nrpc_client.Connect()
+defer nrpc_client.CloseConnection()
+otherwise, the code will still connect there and will not disconnect at the end of the microservice.
\ No newline at end of file
diff --git a/bin/templates/readme.rus b/bin/templates/readme.rus
new file mode 100644
index 0000000..32870aa
--- /dev/null
+++ b/bin/templates/readme.rus
@@ -0,0 +1,44 @@
+Сервис реализует синхронный обмен данными.
+
+Сервис для обмена данными с БД Postgres SQL
+Обмен данными сделано разными методами:
+1. Команды в NATS по чтению, изменению и др.
+2. DB CRUD операции - прямой обмен с БД
+   (в каждой модели таблицы есть методы Read(), Update(), Create(), Save(), Delete(), Restore())
+3. GRPC - обмен с БД по протоколу GRPC
+   (сервис клиент которому надо обмениваться с БД подключается к сервису серверу sync_exchange, последний обменивается с БД)
+4. NRPC - обмен с БД по протоколу NRPC
+   (сервис клиент которому надо обмениваться с БД подключается к сервису NATS, который передаёт команды серверу sync_exchange, последний обменивается с БД)
+
+Перед началом выполнения CRUD операций надо указать транспорт по которому будет происходить обмен (CRUD, GRPC, NRPC)
+с помощью одной из команд:
+InitCrudTransport_DB()
+InitCrudTransport_GRPC()
+InitCrudTransport_NRPC()
+из модуля
+"gitlab.aescorp.ru/dsp_dev/claim/sync_service/pkg/crud_starter"
+
+Также для начала работы должны быть заполнены переменные окружения:
+
+1) для DB CRUD:
+   DB_HOST="10.1.9.23"
+   DB_NAME="claim"
+   DB_SCHEME="public"
+   DB_PORT="5432"
+   DB_USER=""
+   DB_PASSWORD=""
+
+2) для GRPC:
+   SYNC_SERVICE_HOST=10.1.9.150
+   SYNC_SERVICE_PORT=30031
+
+3) для NRPC:
+   BUS_LOCAL_HOST="10.1.9.150"
+   BUS_LOCAL_PORT=30222
+
+Для NRPC (GRPC) желательно сначала подключиться туда и в конце отключиться
+nrpc_client.Connect()
+defer nrpc_client.CloseConnection()
+иначе код всё равно туда подключится, и не отключится в конце работы микросервиса.
+
+