Service
Make sure you add the name of the service what what it is.
Background
Add a background.
Why a service?
Why is it important to have a service.
Server
Explain the server side of things.
Worker
Explain the worker side of things.
Client
Explain the client side of things.
Health
The system defines a way to monitor all of it's dependencies.
To configure we just need the have the following configuration:
health:
duration: 1s (how often to check)
timeout: 1s (when we should timeout the check)
[health]
duration = "1s (how often to check)"
timeout = "1s (when we should timeout the check)"
Deployment
Since we are advocating building microservices, you would normally use a container orchestration system. Here is what we recommend when using this system:
Design
Add anything interesting about the design.
Other Systems
Describe any other similar systems you took inspiration from.
Development
If you would like to contribute, here is how you can get started.
Structure
The project follows the structure in golang-standards/project-layout.
Dependencies
Please make sure that you have the following installed:
Style
This project favours the Uber Go Style Guide
Setup
The get yourself setup, please run the following:
make setup
Binaries
To make sure everything compiles for the app, please run the following:
make build-test
Features
To run all the features, please run the following:
make features
Changes
To see what has changed, please have a look at CHANGELOG.md