woop/README.md

Harmony Benchmark

Coding Guidelines

• In general, we should follow effective_go
• Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
• Code must be documented adhering to the official Go commentary guidelines.

Dev Environment Setup

export GOPATH=$HOME/<path_of_your_choice>

mkdir -p $HOME/<path_of_your_choice>/src

cd $HOME/<path_of_your_choice>/src

git clone git@github.com:simple-rules/harmony-benchmark.git

cd harmony-benchmark

go get ./...

Usage

Running local test without db

./deploy.sh local_config.txt

Running local test with db

./deploy.sh local_config.txt 1

Testing

Make sure you the following command and make sure everything passed before submitting your code.

./test_before_submit.sh

Linting

Make sure you the following command and make sure everything passes golint.

./lint_before_submit.sh