This is a development exercise for building a prepaid card service written in Go.
- Docker
- Git
- GNU Make (optional) - Make is used for convenience as a shortcut to commands. If you prefer, you can always run the commands, which are listed in the Makefile.
Follow the steps to setup your development workspace:
- Clone the repository
$ git clone git@github.com:sepetrov/prepaidcard.git ~/Projects/prepaidcard
- cd into the project directory
$ cd ~/Projects/prepaidcard
- Create file with environment variables for Docker from the template
.env.dist
$ cp .env.dist .env
- Build and start the API containers
- for testing and usage run
$ make up
- for development run
$ make dev
- for testing and usage run
The API should be accessible on the port number configured in .env
,
e.g. http://localhost:${API_PORT}.
The OpenAPI Specification can be found in doc/openapi.yml.
To read the API specification and to test the API you can build and start the doc
container.
$ make doc
This container will be accessible on the port number configured in your .env
file as DOC_PORT
,
e.g. http://localhost:${DOC_PORT}.