README
This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Go version: 1.15
-
System dependencies
- toml - for parsing toml file with server configuration
- logrus - logger for show error, warning or other
- gorilla/mux - HTTP router and URL matcher for building Go web servers
- stretchr/testify - tools for testifying the go code
-
Configuration:
- Compile application:
make - Start the Go server:
./apiserver - Test connection:
localhost:8080/hello - Run tests:
make test
- Compile application:
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
References
-
...