INSTALL.md

Installation instructions

Please follow the following steps in order to set up your development environment.

Bare metal (local)

1. Install Golang +1.10.x (assuming git is already installed).
2. Make a default repository for cloning the project. This should be strictly inside the GOPATH. Paste this instruction in your terminal to get started. mkdir -p $GOPATH/src/github.com/bench-routes.
3. Navigate to the directory via cd $GOPATH/src/github.com/bench-routes.
4. Clone the repository via git clone https://github.com/bench-routes/bench-routes.git.
5. Navigate into the cloned repo cd bench-routes.
6. Install all dependencies via go get -v -u ./....
7. To start running, make run will start the service.
8. To setup and run the UI for the project kindly follow the instructions mentioned here.

Docker

1. Make sure docker is installed, and your user is in the docker group.
2. Run docker build -t bench-routes .
3. Run docker run -p 9990:9990 -it bench-routes

Installation Instructions for Windows system using WSL

1. Install WSL in your windows machine.
2. Install Golang in your WSL distro.
3. Set the gopath in WSL.
4. Open the project in VScode WSL window.
5. Install all dependencies via go get -v -u ./....
6. To start running, make run will start the service.

Please feel free to open any new-issue in case you encounter with any issues while setting up the development environment.