git clone https://github.com/Digital-Certificates-DL/certificates-svc
cd certificates-svc
go build main.go
export KV_VIPER_FILE=./config.yaml
./main migrate up
./main run service
We do use openapi:json standard for API. We use swagger for documenting our API.
To open online documentation, go to swagger editor here is how you can start it
cd docs
npm install
npm start
To build documentation use npm run build
command,
that will create open-api documentation in web_deploy
folder.
To generate resources for Go models run ./generate.sh
script in root folder.
use ./generate.sh --help
to see all available options.
- Set up environment value with config file path
KV_VIPER_FILE=./config.yaml
- Provide valid config file
- Launch the service with
migrate up
command to create database schema - Launch the service with
run service
command
For services, we do use PostgresSQL database. You can install it locally or use docker image.