-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1235 from damassi/update-docs-docker
Update README.md
- Loading branch information
Showing
1 changed file
with
17 additions
and
6 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 |
---|---|---|
|
@@ -20,6 +20,23 @@ Meta | |
Set-Up | ||
--- | ||
|
||
- Copy `.env.example` to `.env` in the root of the project and edit all `REPLACE` values with sensitive configuration obtained from `positron-staging`. This should help. | ||
|
||
``` | ||
heroku config --app=positron-staging | grep -E `cat .env.example | grep REPLACE | cut -f1 -d= | xargs | tr ' ' \|` | sed -e 's/:\ /=/g' | sed -e 's/ //g' | ||
``` | ||
|
||
### Via Docker Compose | ||
- Install [Docker for Mac](https://docs.docker.com/docker-for-mac/install/) | ||
- git clone [email protected]:<your username>/positron.git && cd positron | ||
- `docker-compose up` | ||
|
||
This starts a new self-contained Docker instance that boots MongoDB, ElasticSearch and Node. Changes made to source-code located in `api` and `client` is [automatically reloaded](https://github.com/artsy/positron/blob/master/lib/reloadable.js) on browser-refresh; no need to restart the process. | ||
|
||
To shut down the process, press `ctrl+c` or execute `docker-compose down`. | ||
|
||
### Manually | ||
|
||
- Install [NVM](https://github.com/creationix/nvm) | ||
- Install Node 6 | ||
|
||
|
@@ -41,12 +58,6 @@ git clone [email protected]:craigspaeth/positron.git && cd positron | |
yarn install | ||
``` | ||
|
||
- Copy `.env.example` to `.env` in the root of the project and edit all `REPLACE` values with sensitive configuration obtained from `positron-staging`. This should help. | ||
|
||
``` | ||
heroku config --app=positron-staging | grep -E `cat .env.example | grep REPLACE | cut -f1 -d= | xargs | tr ' ' \|` | sed -e 's/:\ /=/g' | sed -e 's/ //g' | ||
``` | ||
|
||
- Positron uses MongoDB as a database. To install MongoDB using homebrew do the following, if you would prefer to install manually check the documentation at [MongoDB](http://docs.mongodb.org/manual/tutorial/install-mongodb-on-os-x/) | ||
|
||
``` | ||
|