Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: update Docker dev environment #289

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+20 −0
Open

build: update Docker dev environment #289

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b923491
build: update Docker dev environment
eatyourgreens Nov 18, 2024
87ce564
Add /lib to mounted volumes
eatyourgreens Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docker-compose.dev.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,12 @@ services:
YAML_TEMPLATE: "config/oxford.yaml"
command: "yarn dev"
volumes:
- ./.material:/app/.material
- ./config:/app/config
- ./components:/app/components
- ./pages:/app/pages
- ./public:/app/public
- ./styles:/app/styles
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I've got all the places that you might want to make changes while working on the app, but I could be wrong.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there are a few more (lib, scripts, config, docs, ...). Perhaps you could map the entire root dir to /app/?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about directories like docs, because they aren't used by the running Next.js app.

It might be worth adding a docs service to the compose file, though, so you could see the Next.js app on one port, and the docs site on another.

I'm also wondering whether to add a CLI shell so that people can run yarn scripts inside a container. At the moment, you can't easily run the tests in Docker.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just tried running the tests in a container, and they failed with missing dependency errors. That's a problem for another day.

docker compose -f docker-compose.dev.yml run --rm gutenberg yarn e2e

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

scripts folder too.

You also need files from the base directory, the next.config, the cypress.config and possibly the cypress.d?, tsconfig, tailwind config, the .env and .local.env.

ports:
- "3000:3000"
links:
Expand Down
15 changes: 15 additions & 0 deletions docs/development/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,18 @@ value (under `services.gutenberg.build.args`) to a different config yaml file or
changing `MATERIAL_METHOD` to `"copy"` to copy a locally checked out folder into
the container at build-time instead of pulling fresh - for more details on how
to pull material to edit locally follow the below section.

## Local development with Docker

`docker-compose.dev.yaml` configures a local development environment in Docker,
including Node and Yarn. It runs the app in development mode, so that you can make
changes to the code and see them on http://localhost:3000.

```sh
# build the development image
docker compose -f docker-compose.dev.yaml build
# run the Next.js app on http://localhost:3000 in development mode
docker compose -f docker-compose.dev.yaml up
# shut down the app and database when you're finished
docker compose -f docker-compose.dev.yaml down
```