Skip to content

Commit

Permalink
Updating readme with new building guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
marcossegovia committed Nov 1, 2016
1 parent 4dafd43 commit 08e453c
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,29 @@ MyWins is a service to track your daily routines whatever it is, just to cheer y

##How it works

1. You should download the app form `url` and create an account.
1. You should download the app form `url` and create an account. (To be done)
2. After you've already log in, you'll be asked to submit your success or your fail of the day.
3. Keep your wins green!

##Installation

You just `go get github.com/MarcosSegovia/MyWins` so you'll get the repository inside your go workspace, be sure to get [glide](https://github.com/Masterminds/glide) to be able to get dependencies. If so, then run `glide install`
1. You just `go get github.com/MarcosSegovia/MyWins` so you'll get the repository inside your go workspace.
2. Be sure to get [glide](https://github.com/Masterminds/glide) to be able to get dependencies.
3. If so, then run `glide install`


##How to build and run it locally

1. `go build -o bin/mywins src/*.go`
2. `./bin/mywins`
3. MyWins will be running on 0.0.0.0:8080

> To be able to check the app functionality you would have to provide a mongodb installation and set the environment variables inside `mongo.go` with your own host and port from your mongodb client.
##How to build and run it with Docker locally

1. First uncomment the `Local Development` Dockerfile code and comment the `Production/Staging` one.
2. Build it by the provided Dockerfile `docker build -t marcossegovia/mywins .`
3. Run it by executing `docker run -d -P marcossegovia/mywins`
3. Run the docker-compose file like the following `docker-compose up -d mywins`
4. You will see how Docker will get a free port to expose the server: so run a `docker ps` and you'll see the app running on the 0.0.0.0:{port}

0 comments on commit 08e453c

Please sign in to comment.