Skip to content

Commit

Permalink
docs: Update Countries module & added description about docker setup
Browse files Browse the repository at this point in the history
  • Loading branch information
cheatsnake committed Sep 12, 2022
1 parent 0943fbb commit d8518a6
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README_RU.md
Original file line number Diff line number Diff line change
Expand Up @@ -525,6 +525,7 @@ GET https://shadify.dev/api/countries/capital-quiz
| Параметр | Описание |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `variants` | _Опциональный_ <br> Число от 2 до 6, соответствует количеству различных вариантов, из которых вы должны выбрать правильную столицу заданной страны. <br> Значение по умолчанию – 4. |
| `amount` | _Optional_ <br> Число от 1 до 20 которое отвечает за количество возвращаемых заданий. Использование этого параметра гарантирует, что среди всех полученных заданий все будут уникальными. <br> Значение по умолчанию – 1. |

Возвращаемый ответ:

Expand Down Expand Up @@ -553,6 +554,7 @@ GET https://shadify.dev/api/countries/country-quiz
| Параметр | Описание |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `variants` | _Опциональный_ <br> Число от 2 до 6, соответствует количеству различных вариантов, из которых вы должны выбрать правильную страну по заданному изображению флага. <br> Значение по умолчанию – 4. |
| `amount` | _Optional_ <br> Число от 1 до 20 которое отвечает за количество возвращаемых заданий. Использование этого параметра гарантирует, что среди всех полученных заданий все будут уникальными. <br> Значение по умолчанию – 1. |

Возвращаемый ответ:

Expand All @@ -579,11 +581,36 @@ GET https://shadify.dev/api/countries/country-quiz
git clone https://github.com/cheatsnake/shadify.git
```

2. Находясь в корне проекта запустите следующую команду:
2. Установить зависимости:

```sh
go mod download
```

3. Находясь в корне проекта запустите следующую команду:

```sh
go run cmd/server/main.go
```


## Запуск сервера в Docker

Запуск Docker-контейнера для разработки (после любых изменений сервер будет перезапускаться):

```sh
docker compose up
```

Запуск Docker-контейнера для production:

```sh
docker build -t shadify . --target prod
```

```sh
docker run --rm -p 5000:5000 --name shadify shadify
```

<div align="center">Made with &#9829;</div>
<div align="center"><a href="https://github.com/cheatsnake/shadify/blob/master/LICENSE">LICENSE</a> 2022</div>

0 comments on commit d8518a6

Please sign in to comment.