Browse Source

fix readme

master
Artem Shkilev 2 years ago
parent
commit
576e62fe26
Signed by: Misterzym
GPG Key ID: 548AD371FC00BF4C
  1. 2
      README.md

2
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.

Loading…
Cancel
Save