Environment Prep
Once you have cloned the repo, you will need the following tools for local development.
Go
You should use Go 1.11 or newer. We recommend gvm for installing and managing your versions of Go.
All of the commands below assume you have your GOPATH set to the root of the project directory. This is by design because we found (after many projects) it is much easier for you to clone the repo and make changes without having to rewrite imports if they are all contained within the project.
Node and npm
You should install NodeJS and npm.
These are the current versions on the front-end components:
Visual Studio Code (VSCode) Setup
You can use any IDE, but here is what you need for VSCode. It was quite a challenge getting ESLint to work properly when the .eslintrc.js file is not in the root of the project - the trick was the "eslint.workingDirectories" setting. All the settings are included in the .vscode/settings.json file. I use VSCode open only to the root of the project with no other projects. I recommend the following VSCode extensions:
Environment Variables
You can also use direnv which sets your environment variables based on your current directory. For instance, you can install direnv, create a file in the root of this project called .envrc, and paste in the following:
# Set $GOPATH for Go.
export GOPATH=`pwd`
# Add the local Go bin directory and the npm bin directory to $PATH.
export PATH=$PATH:`pwd`/bin:`pwd`/src/app/ui/node_modules/.bin
Save the file and type direnv allow. That will automatically set environment variables when you CD into the project root and child folders.
Makefile Commands
Start Services
You can run these commands from different terminals to start the services.
# Create and run the database container.
make db-init
# Start the UI in local dev mode after installing dependencies.
make ui-dep
make ui-dev
# Start the API in local dev mode after installing the dependencies.
make api-dep
make api-dev
# Start the documentation service in local dev mode after install the dependencies.
make doc-dep
make doc-dev
Database Control
These are other database commands you can use:
# Start the DB container.
make db-start
# Stop the DB container.
make db-stop
# Drop the database, create a new database, and apply new migrations.
make db-reset
# Delete the DB container.
make db-rm
UI and API Tests
Run tests for UI:
# Run the UI tests.
make ui-test
Run tests for the API:
# Create and run the database container.
make db-init
# Run the API tests.
make api-test