Skip to content

Commit

Permalink
update the project README
Browse files Browse the repository at this point in the history
  • Loading branch information
eatyourgreens committed Nov 14, 2024
1 parent 0a69cc4 commit 3ab9772
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions packages/app-project/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,18 @@ Once you have the hosts file configured, you'll be able to use one of those subd

### Docker

- `docker compose up -d` to run a dev server, in the background, on https://localhost:3000 and the storybook on http://localhost:9001 using `yarn dev` and `yarn storybook` respectively. The `--build` flag can be used to build the container. This builds and runs a local image which matches the Jenkins build except for running behind a proxy. Note: `devcert` is not yet setup for our docker build for local development.
- `docker compose down` to stop the dev containers.
- `docker compose run --rm project test` to run the tests.
```sh
# run a development build using the top-level Dockerfile
docker compose build
# run a dev server on port 3000 (with HTTPS) and a storybook on port 9001.
# eg. https://localhost:3000/projects/nora-dot-eisner/planet-hunters-tess
# http://localhost:9001
docker compose up -d
# stop the local services when you're finished
docker compose down
# run the tests
docker compose run --rm project test
```

### Node
```sh
Expand Down

0 comments on commit 3ab9772

Please sign in to comment.