Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Yu-Leo authored Nov 19, 2023
1 parent e26687d commit 57c381b
Showing 1 changed file with 27 additions and 14 deletions.
41 changes: 27 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,6 @@ make d-run

Структура проекта основана на [go-clean-template](https://github.com/evrone/go-clean-template).

В качестве линтера используется [golangci-lint](https://golangci-lint.run/) с [конфигом](./.golangci.yml).

### Make-команды

- `make build` - сборка
Expand All @@ -85,18 +83,15 @@ make d-run

Значения параметров задаются в [`config/config.yaml`](./config/config.yaml) и в переменных окружения.

### Технологии
### Линтер

- СУБД: **SQLite3**
- Язык программирования: **Go (1.20)**
- Фреймворки и библиотеки:
- [`gin`](https://github.com/gin-gonic/gin) - HTTP веб-фреймворк
- [`swag`](https://github.com/swaggo/swag) - автоматическая генерация RESTful API документации с Swagger 2.0
- [`cleanenv`](http://github.com/ilyakaznacheev/cleanenv) - минималистичный конфигуратор настроек
- [`logrus`](http://github.com/sirupsen/logrus) - логгер
- Инструменты
- **Docker**
- **make**
В качестве линтера используется [golangci-lint](https://golangci-lint.run/). Конфиг задается в файле [./.golangci.yml](./.golangci.yml).

Линтер запускается при помощи команды:

```bash
make lint
```

### Unit-тесты

Expand All @@ -115,6 +110,8 @@ P.S. Поскольку на данном этапе развития проек

End-to-end тесты написаны на Python. Располагаются в директории [`./e2e-tests`](./e2e-tests).

В пайплайне запускаются в Docker-контейнерах при помощи Docker Compose ([конфиг](./docker-compose.ci.yaml)).

### CI/CD

В качестве инструмента для CI/CD используется GitHub Actions.
Expand All @@ -125,8 +122,24 @@ End-to-end тесты написаны на Python. Располагаются

1. Сборка проекта
2. Запуск линтера
3. Запуск unit-тестов
3. Запуск тестов
- Запуск unit-тестов
- Запуск e2e-тестов

### Используемые технологии

- Язык программирования: **Go (1.20)**
- Фреймворки и библиотеки:
- [`gin`](https://github.com/gin-gonic/gin) - HTTP веб-фреймворк
- [`swag`](https://github.com/swaggo/swag) - автоматическая генерация RESTful API документации с Swagger 2.0
- [`cleanenv`](http://github.com/ilyakaznacheev/cleanenv) - минималистичный конфигуратор настроек
- [`logrus`](http://github.com/sirupsen/logrus) - логгер
- СУБД: **SQLite3**
- Инструменты
- **Docker** и **Docker compose**
- **make**
- **GitHub Actions**

<a id="chapter-4"></a>

## :smile: Авторы
Expand Down

0 comments on commit 57c381b

Please sign in to comment.