platform

README

Platform

The Tidepool Platform API.

Setup

1. Install Go version 1.6 or later.
2. Create a brand new Go directory.
3. Set the GOPATH environment variable to the newly created Go directory.
4. Add $GOPATH/bin to the PATH environment variable.
5. Execute go get github.com/tidepool-org/platform to pull down the project. You may ignore a "no buildable Go source files" warning.
6. Change directory to $GOPATH/src/github.com/tidepool-org/platform.
7. Source the .env file.
8. Execute make editable to install the various Go tools needed for building and editing the project.

For example:

brew install go
mkdir ~/go
export GOPATH=~/go
export PATH=$GOPATH/bin:$PATH
go get github.com/tidepool-org/platform
cd $GOPATH/src/github.com/tidepool-org/platform
source .env
make editable

For reuse, you may want to include the following lines in your shell config (e.g. .bashrc) or use a tool like direnv:

export GOPATH=~/go
export PATH=$GOPATH/bin:$PATH

Execute

1. Setup the environment, as above.
2. Build the project.
3. Execute the dataservices and/or userservices executable.

In addition to the setup above, for example:

make build
_bin/dataservices/dataservices

Use Ctrl-C to stop the executable. It may take up to 60 seconds to stop.

Makefile

• To setup your Go environment for building and editing the project:

make editable

• To build the executables:

make build

All executables are built to the _bin directory in a hierarchy that matches the locations of executable source files.

The environment variable BUILD indicates which executables to build. If not specified, then all executables are built. For example, to build just the executables found in the dataservices directory:

BUILD=dataservices make build

• To run all of the tests manually:

make test

The environment variable TEST indicates which package hierarchy to test. If not specified, then all packages are tested. For example,

TEST=user make test

• To run all of the tests automatically after any changes are made, in a separate terminal window:

make watch

The environment variable WATCH indicates which package hierarchy to test. If not specified, then all packages are tested. For example,

WATCH=user make watch

• To run gofmt, goimports, go tool vet, and golint:

make pre-commit

• To clean the project of all build files:

make clean

• To add the required git hooks:

make git-hooks

Sublime Text

If you use the Sublime Text editor with the GoSublime plugin, open the platform.sublime-project project to ensure the GOPATH and PATH environment variables are set correctly within Sublime Text. In addition, the recommended user settings are:

{
  "autocomplete_builtins": true,
  "autocomplete_closures": true,
  "autoinst": false,
  "fmt_cmd": [
    "goimports"
  ],
  "fmt_enabled": true,
  "fmt_tab_width": 4,
  "use_named_imports": true
}