Starter project template using the following libraries/frameworks:

• Gin Gonic
• Govendor
• Angular
• Protocol Buffers
• GORM
• Socket.io
• JWT

Services for CI & CD:

• Travis CI
• Heroku CD

To get the project, you need to install Go and set your Go workspace (i.e. $GOPATH) first.

$ git clone https://github.com/zaebee/litclub.git

If not yet installed, install govendor via:

$ go get -u github.com/kardianos/govendor

To install the golang dependencies, run

$ go mod vendor

in root of project.

If not yet installed, install node + npm/yarn, e.g. for Mac OS run

$ brew install npm

which will also install Node.js if it is not already installed.

To install the Angular dependencies, run

$ cd ./frontend
$ npm install

in root of project.

If not yet installed, install protoc, e.g. for Mac OS, run

$ brew install protobuf

and for the Go protocol buffers plugin:

$ go get -u github.com/golang/protobuf/protoc-gen-go
$ go get -u github.com/favadi/protoc-go-inject-tag

The compiler plugin protoc-gen-go will be installed in $GOBIN, defaulting to $GOPATH/bin. It must be in your $PATH for the protocol compiler protoc to find it.

Assuming you have run npm install before (see above), which installs the protobuf.js dependency continue with the compilation as follows. To compile the schema to Go and Typescript sources run

$ cd ./proto
$ sh ./compile_proto.sh

in root of project.

To start the application with PostgreSQL database, Golang backend, and Angular frontend, the following steps are required.

Run

$ docker-compose -f docker-compose.dev.yml

in root of project directory. This will fire up a database listening on port 5432 of your localhost.

To start the backend server on port 8080 run

$ go run backend/main.go

in root of project directory.

To start the frontend server on port 4200 run

$ cd ./frontend
$ npm run start

in root of project directory.