forked from Waasi/gotenna-dashboard
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): added content to README
- Loading branch information
Showing
2 changed files
with
21 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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= |