Skip to content

Commit

Permalink
update read me
Browse files Browse the repository at this point in the history
  • Loading branch information
nionata committed May 25, 2020
1 parent 0c4a914 commit 2ef1290
Showing 1 changed file with 19 additions and 12 deletions.
31 changes: 19 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,27 @@ The development environment is composed of four servers. The first one is run wi

#### Running

`stem-c-client-dev`

1. Install [Node](https://nodejs.org/en/) and [Yarn](https://classic.yarnpkg.com/en/docs/install#windows-stable)

2. Run the following commands sequentially

```Bash
cd client
yarn install
yarn start
```

`stem-c-cms-dev`, `stem-c-compile-dev`, and `stem-c-db-dev`

1. Install [docker](https://docs.docker.com/get-docker/)
3. Run `docker-compose up`

`stem-c-client-dev`
> If you do not meet these [requirements](https://docs.docker.com/toolbox/toolbox_install_windows/) docker desktop will not initialize popery. There are some unofficial modifications, however, we recommend installing the docker [toolbox](https://docs.docker.com/toolbox/toolbox_install_windows/)
1. Run the following commands sequentially
2. Run `docker-compose up`

```powershell
cd client
yarn install
yarn start
```
> Grant **cms** permission if it prompts you
### Staging

Expand Down Expand Up @@ -127,8 +134,8 @@ heroku container:release web

### Pull Requests

> PRs to **master** should squash and merge
>
> PRs to all other branches should create a merge commit
Before submitting a pull request, merge the target branch into the working branch to resolve any merge conflicts. Include a description of the changes made.

- PRs to **master** should squash and merge
- PRs to all other branches should create a merge commit

Before submitting a pull request, merge the target branch into the working branch to resolve any merge conflicts. Include a description of the changes made.

0 comments on commit 2ef1290

Please sign in to comment.