Skip to content

Commit

Permalink
feat: documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
rushtong committed Sep 17, 2024
1 parent 9d8c5db commit f6559ab
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions DEVNOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ nvm install 22.6.0
npm install
```

3. Install configs for an environment. This example is for the `alpha` environment, but you can use values from any environment by looking at the deployed configs in https://duos-k8s.dsde-{%ENV%}.broadinstitute.org/config.json where {%ENV%} is any of `dev`, `staging`, `alpha`, or `prod`
Remember to set the `env` value appropriately, for example, `dev`. Certain features are not available on different environments and this will simulate that for local development.
The installation steps outlined in this step can also be completed using the [render-configs.sh](scripts/render-configs.sh) script which can generate all required
files for local development.
3. Install configs for an environment. This example is for the `alpha` environment, but you can use values from any
environment by looking at the deployed configs in https://duos-k8s.dsde-{%ENV%}.broadinstitute.org/config.json where
{%ENV%} is any of `dev`, `staging`, `alpha`, or `prod`. Remember to set the `env` value appropriately, for example,
`dev`. Certain features are available only in specific environments. Setting the `env` value to the desired environment
will simulate it for local development. The installation steps outlined in this step can also be completed using the
[render-configs.sh](scripts/render-configs.sh) script which can generate all required files for local development.
```
cp config/alpha.json public/config.json
```
Expand Down Expand Up @@ -50,8 +52,9 @@ npm start
```
### Running under Docker

Update your local `docker-compose.yaml` file to mount the preferred `config.json` file in app volumes.
Remember to set the `env` value appropriately, for example, `dev`. Certain features are not available on different environments and this will simulate that for local development.
Update your local `docker-compose.yaml` file to mount the preferred `config.json` file in app volumes. Remember to set
the `env` value appropriately, for example, `dev`. Certain features are available only in specific environments. Setting
the `env` value to the desired environment will simulate it for local development.

```yaml
volumes:
Expand Down

0 comments on commit f6559ab

Please sign in to comment.