Skip to content

Commit

Permalink
chore(docs): added content to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Waasi committed Dec 3, 2018
1 parent c6a2aed commit c8f49d2
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 7 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,28 @@
# GoTenatious Mesh Dashboard

GoTenatious Mesh emergency feed dashboard

## Requirements

- [Docker](https://www.docker.com/)

## Setup

- Copy `example.env` as `.env`
- Add `MONGO_HOSTNAME` value
- Add `BASE_URL` value
- `make build`
1. Copy `example.env` as `.env`
2. Add `MONGO_HOSTNAME` value
3. Add `BASE_URL` value
4. Add `DB_NAME` value
5. Add `PORT` value
6. Run `make build`

## Run
- `make up`

To run the app do: `make up`

## Contributing

1. Fork it ( https://github.com/[my-github-username]/dashboard/fork )
2. Create your feature branch (git checkout -b feature/my_new_feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
6 changes: 4 additions & 2 deletions example.env
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
MONGO_HOSTNAME=
BASE_URL=
PORT=
DB_NAME=
BASE_URL=
MONGO_HOSTNAME=

0 comments on commit c8f49d2

Please sign in to comment.