Fullstack OTP

My Bachelor Thesis.

Documentation will be written after the application is finished.

Requirements

• Docker and Docker Compose
• Go 1.16+
• Postman Agent
• Direnv
• Shell that supports make, curl, and sh. WSL / Ubuntu / OS X should be able to do this just fine without any configuration.

Installation

• Go to the project directory.

cd fullstack-otp

• Initialize environment variables. It is recommended that you use direnv in order to set all of them. The .envrc provided here should help you get started right away. Remember the rename .envrc.example to .envrc so direnv can read it properly.

mv .envrc.example .envrc
nano .envrc

• Allow direnv in your project. You are going to need these environment variables, so it is the best not to forget about it.

direnv allow .
eval "$(direnv hook zsh)" # or your favorite shell

• Provision infrastructures.

make start-infrastructure

• Run Go application.

make start

• Run unit tests.

make test

• Run integration tests, either with make e2e or Postman.

• Stop infrastructures.

make stop-infrastructure