routes-service

README

routes-service

Run

You can find compiled binaries on the Release section.

Go install

go install github.com/shoriwe/routes-service@latest

After installing the binary you can run a temp server with the database running in memory with:

routes-service 127.0.0.1:5000

Docker compose

A ready to go docker-compose.yaml can be found at the root of the repository

docker compose -f docker-compose.yaml up -d

You can access the service at 127.0.0.1:5000.

Docker image

docker run -p 5000:5000 -d ghcr.io/shoriwe/routes-service:latest

Documentation

You will find the entire documentation for this project at docs/.

File	Description
docs/README.md	Detailed description of the documentation files.
CONTRIBUTING.md	Rules for contributing to this repository. Including commit nomenclature, code quality and more.
CHANGELOG.md	This file is autogenerated by the Build Action's pipeline, should never be modified manually.

Testing

Make sure you have the testing PostgreSQL service running. You can setup one easily with:

docker compose -f testing.docker-compose.yaml up -d

Finally:

go test -count=1 -v ./...

Coverage