Skip to content

Commit a87d607

Browse files
committed
Document dev container usage
1 parent c4b9b2e commit a87d607

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

.devcontainer/devcontainer.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
"service": "app",
77
"workspaceFolder": "/workspace",
88
"shutdownAction": "stopCompose",
9+
// Expose the application + the mailcatcher for checking emails.
910
"forwardPorts": [8080, 1080],
11+
// Wipes the database on every start.
1012
"postStartCommand": "rm -rf /db && mkdir -p /db",
1113
"customizations": {
1214
"vscode": {

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,3 +157,15 @@ Not verified
157157

158158
## Fly.io
159159
- Deployment URL [makespace-app.fly.dev](https://makespace-app.fly.dev/)
160+
161+
# DevContainer
162+
Dev containers are a way to create a reproducible dev environment https://code.visualstudio.com/docs/devcontainers/containers.
163+
164+
Setup (vscode):
165+
1. Install the dev container extension from Microsoft
166+
2. Ctrl+Shift+P then type 'Dev Containers: Rebuild and Reopen in Container'
167+
3. Vscode will reload into the dev container - you can now develop with all the required tools already installed
168+
4. Type `make start` to start the application to perform manual local testing.
169+
170+
Each time you start the dev container the database will be reset to empty.
171+

0 commit comments

Comments
 (0)