Skip to content

Commit

Permalink
Merge pull request #1235 from damassi/update-docs-docker
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
damassi authored Aug 16, 2017
2 parents 7621ef8 + 0505cd0 commit 66efa8a
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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/)

```
Expand Down

0 comments on commit 66efa8a

Please sign in to comment.