CI-Benchmarker

Architecture

Usage

  docker-compose up

Use the bruno examples in the docs folder to test the system

Development

Start in dev mode

  DEBUG=True go run .

Generate Open API spec

Install swag by using:

  go install github.com/swaggo/swag/cmd/swag@latest

Run swag init in the project's root folder which contains the main.go file. This will parse your comments and generate the required files (docs folder and docs/docs.go).

  swag init

Generate DB code

• Update the sqlc.yaml file with the correct connection string
• Update the schema.sql file with the correct schema
• Update the queries.sql file with the correct queries

  sqlc generate

Make sure the generated types still work ;)

Deployment on a VM with public IP

First run

  touch traefik/acme.json
  chmod 600 traefik/acme.json

Then run

  docker compose up