Housing API

Manage housings through HTTP.

Part of the main qimpl application.

API Documentation

Swagger API documentation can be found at /v1/swagger

Generate Documentation

The Swagger API needs to be generated when modifications are done.

Run the next command to update this documentation:

# swaggo/swag cli is required
# go get -u github.com/swaggo/swag/cmd/swag
$ swag init

Getting started

Run make init to copy all configuration files

Then you can run:

$ docker-compose up

Code Quality

Your commits names should follow the @commitlint/config-conventional rules.

Check and fix your code using:

$ make coding-style

Pre-commit

Install pre-commit following the official documentation

Setup your pre-commit hooks using:

# pre-commit hooks
$ pre-commit install

# message commit hooks
$ pre-commit install --hook-type commit-msg

For additional information check pre-commit docs