platform

README

Platform

The Tidepool Platform API.

Environment

1. Create a brand new go directory.
2. Set the GOPATH environment variable to the new go directory.
3. Add $GOPATH/bin to the PATH environment variable.
4. Execute go get github.com/tidepool-org/platform to pull down the project.
5. Change directory to $GOPATH/src/github.com/tidepool-org/platform.
6. Execute make editable to install the various Go tools needed for building and editing the project.
7. If you are going to use the ginkgo executable, add $GOPATH/src/github.com/tidepool-org/platform/Godeps/_workspace/bin to the PATH environment variable. (Consider using the direnv tool via homebrew to automatically update the GOPATH and PATH environment variables when in certain directories).

Makefile

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

make editable

• To build the executables:

make build

All executables are built in the _bin directory.

• To run all of the tests manually:

make test

The environment variable TEST indicates which test to execute. If not specified, then all tests are executed. 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 test to execute. If not specified, then all tests are executed. For example,

WATCH=user make watch

• To run go fmt, goimports, and golint all at once:

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
}