From f22622116604b6f6afb9b87caf7f89d2c27288db Mon Sep 17 00:00:00 2001
From: Roman Efremov <rs.efremov@digitaldrilling.ru>
Date: Fri, 13 Dec 2024 16:51:39 +0500
Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8=D1=82?=
 =?UTF-8?q?=D1=8C=20Readme=20=D0=BF=D0=BE=20=D0=B7=D0=B0=D0=BF=D1=83=D1=81?=
 =?UTF-8?q?=D0=BA=D1=83=20Persistence=20-=20=D1=81=D0=B5=D1=80=D0=B2=D0=B8?=
 =?UTF-8?q?=D1=81=D0=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 Persistence.API/Readme.md | 55 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 Persistence.API/Readme.md

diff --git a/Persistence.API/Readme.md b/Persistence.API/Readme.md
new file mode 100644
index 0000000..b5c5e29
--- /dev/null
+++ b/Persistence.API/Readme.md
@@ -0,0 +1,55 @@
+# Persistence Service Readme
+
+## Краткое описание
+Persistence сервис отвечает за работу с хранимыми данными
+в рамках совокупности различных систем.
+
+## Локальное развертывание
+1. Скачать репозиторий по SSH 
+```
+ssh://git@git.ddrilling.ru:2221/on.nemtina/persistence.git
+```
+
+Для доступа к репозиториям редварительно необходимо сгенерировать SSH ключ и добавить его в Gitea
+
+2. Выбрать ветку master
+3. Через терминал перейти в папку с решением и выполнить команду:
+```
+dotnet ef database update --project Persistence.Database.Postgres --context PersistencePostgresContext
+```
+
+## Использование Swagger-а
+1. Сконфигурировать appsettings.Development.json
+(при отсутствии) занести флаг:
+```json
+"NeedUseKeyCloak": true
+```
+2.  Запустить решение в режиме Debug
+3.  Выполнить авторизацию через KeyCloak - качестве client_id указать: 
+```
+webapi
+```
+После этого должен произойти редирект на страницу авторизации в KeyCloak
+
+4. Заполнить поля и авторизоваться
+```
+Username or email: myuser
+```
+```
+Password: 12345
+```
+
+## Тестирование
+Запуск тестов рекомендуется осуществлять без использования KeyCloak<br> Для этого 
+настройка appsettings.Tests.json должна содержать:
+```
+"NeedUseKeyCloak": false,
+"AuthUser": {
+  "username": "myuser",
+  "password": 12345,
+  "clientId": "webapi",
+  "grantType": "password"
+}
+```
+
+