From 576e62fe26dea0131f5f295fd13ba9e55b2b5575 Mon Sep 17 00:00:00 2001 From: Artem Shkilev Date: Mon, 18 Sep 2023 23:49:50 +0300 Subject: [PATCH] fix readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index bef0b32..57196c3 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ Для простой установки можно выполнить ```bash git clone https://source.net-bit.ru/Misterzym/Easy-gallery-cloud-API.git +cd Easy-gallery-cloud-API docker-compose up -d ``` Перед запуском сборки, можно настроить свои файловые хранилища в .env файле, по умолчанию будет использоваться файловая система. Однако включен и установлен пакет, позволяющий использовать s3 в качестве места хранения, так как именно для него он и разрабатывался. @@ -21,6 +22,7 @@ docker-compose up -d Так как проект представляет собой голый API - удобнее всего будет пользоваться им из идущего в комплекте Swagger, достаточно открыть его по адресу **/api/documentation**. Из проекта удалена авторизация, по этому для проверки работы не потребуется генерировать токены и прочее. Названия и описания методов очень точно и емко описывают их работу, а все передаваемые данные подписаны, для простоты понимания. + ![API.png](API.png) ### Тесты Проект полностью покрыт unit тестами, для полноты охвата использовались интеграционные тесты, которые проверяют не просто работу отдельных функций, а целиком работу отдельных endpoint'ов API.