The open source programming language Go will be used to develop the whole project, mainly because I want to try a new language and this one is becoming quite popular nowadays.
Gin is a HTTP web framework written in Go (Golang). It features a Martini-like API with much better performance – up to 40 times faster.
It is very well documented and provides many handy features like authentication, data validation and a configurable logger out of the box.
Mage is a make/rake-like build tool using Go. You write plain-old go functions, and Mage automatically uses them as Makefile-like runnable targets.
Mage has no dependencies outside the Go standard library; in this project it is going to be used to automate every possible process like:
mage test: runs the test suite.mage testverbose: runs the test suite with verbosity.mage testandcoverage: runs the test suite generating its code coverage.mage build: builds a binary of the project.mage install: installs the built binary under /usr/local/bin.mage start: Starts the HTTP Server using pm2 as process manager.mage startdev: Starts a dev environment, [WIP].mage stop: Stops the HTTP Server using pm2 as process manager.The relational database engine MariaDB has been choosen to persist the data, it is OpenSource and fulfills the requirements.
Go has support for testing built in to its toolchain which will be used to cover unit and integration tests with the help of testify for the assertions.
Ginkgo will be used as a BDD testing framework and Gomega as a matcher library.
This project will follow the OpenAPI Specification to document its API endpoints, probably using swagger to parse the specifications and generate a static site.
As a process manager the tool PM2 is currently used, because it allows the usage with any language as long as it has a way to build/run it.
Ideally this tool will be replace in favor of a Go tool, some of them has been already tested but none of them provide the same features as PM2.