From 39d3e15d79be0e0165971c7b01150006d7bddfb2 Mon Sep 17 00:00:00 2001 From: Robert Lin Date: Sun, 3 Jun 2018 21:56:14 -0700 Subject: [PATCH] Add Makefile shortcuts Shortcuts created for dependencies, docker-compose start, and standalone starts for the client and server. README updated accordingly. --- Makefile | 21 +++++++++++++++++++++ README.md | 31 ++++++++++++++++++------------- 2 files changed, 39 insertions(+), 13 deletions(-) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..98c1a28 --- /dev/null +++ b/Makefile @@ -0,0 +1,21 @@ +# Installs project dependencies +.PHONY: deps +deps: + go get github.com/codegangsta/gin + (cd server ; go get -u github.com/golang/dep/cmd/dep ; dep ensure) + (cd client ; npm install ) + +# Starts both the server and the client via docker-compose +.PHONY: docker-start +docker-start: + docker-compose -f docker-compose.dev.yml up + +# Starts the client +.PHONY: client +client: + (cd ./client ; npm start) + +# Starts the server +.PHONY: server +server: + (cd ./server ; PORT=9090 ; go run main.go) diff --git a/README.md b/README.md index fc559cd..dddf2fc 100644 --- a/README.md +++ b/README.md @@ -8,30 +8,35 @@ Play the latest version [here](http://bumper.ubclaunchpad.com)! ## Docker Quickstart Install Docker and the Docker Compose toolset. Then run: + ```bash -docker-compose -f docker-compose.dev.yml up +make docker-start ``` ## Manual Quickstart -Go and Node are required. -### Server -[dep](https://github.com/golang/dep) is used for handling server dependencies. +Go and Node are required. To install the required dependencies: + +```bash +$ make deps +``` + +### Run the Server + ```bash -$ cd ./server -$ go get -u github.com/golang/dep/cmd/dep -$ dep ensure -$ go run main.go +$ make server ``` + To add dependencies: + ```bash $ dep ensure -add github.com/my/dependency ``` -### Client +### Start the Client + ```bash -$ cd ./client -$ npm install -$ npm start +$ make clinet ``` -Play at localhost:8080! \ No newline at end of file + +Play at localhost:8080!