An open API service indexing awesome lists of open source software.

https://github.com/zkryaev/timeline

An web-application for booking records in organizations
https://github.com/zkryaev/timeline

go rest-api

Last synced: 6 months ago
JSON representation

An web-application for booking records in organizations

Awesome Lists containing this project

README

          

# Описание
[Документация к проекту](https://github.com/zkryaev/timeline/tree/main/architecture)

# Как запустить

> Фронтенд доступен по `https://localhost`
> Примечание: сервис корректно запускается и работает без `analytics_app` и `analytics_db`

## Настройка и создание конфигурационных файлов

### local.yml
1. Создать файл local.yml и скопировать в него содержимое example.yml
2. Выставить `true` напротив тех фичей, что нужно запустить

### .env
1. Создать файл .env и скопировать в него содержимое .env.example
2. Сгенерировать секретный ключ RSA и задать путь к файлу в SECRET_PATH
3. Задать настройки для запускаемой инфраструктуры (в .env.example все описано)

### nginx.conf
1. Для работы необходимо сгенерировать файлы `cert.crt` и `cert.key`

## Ключевые команды
- `task` - вывод списка основных команд
- `task test` - запустит все тесты
- `MODE=prod task deploy` - поднимет всю систему за вас
- `k6 run load_test/orgs_flow.js` - запустит нагрузочное тестирование (предварительно необходимо установить утилиту k6 от Grafana)

---
END