Skip to content

Commit 4dd8f26

Browse files
committed
chore: docs update
1 parent 39e962b commit 4dd8f26

2 files changed

Lines changed: 14 additions & 6 deletions

File tree

.github/workflows/docker-build.yaml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ on:
66
service:
77
required: true
88
type: string
9-
description: 'Service name to build'
9+
description: "Service name to build"
1010
should-build:
1111
required: true
1212
type: boolean
13-
description: 'Whether to build this service'
13+
description: "Whether to build this service"
1414
secrets:
1515
DOCKERHUB_USERNAME:
1616
required: false
@@ -25,11 +25,11 @@ jobs:
2525
build:
2626
runs-on: ubuntu-latest
2727
if: inputs.should-build
28-
28+
2929
permissions:
3030
contents: read
3131
packages: write
32-
32+
3333
steps:
3434
- name: 📥 Checkout code
3535
uses: actions/checkout@v4
@@ -71,7 +71,6 @@ jobs:
7171
GITHUB_CLIENT_SECRET=${{ secrets.GH_CLIENT_SECRET }}
7272
7373
GITHUB_REDIRECT_URI=https://tracker.nesohq.org/auth/callback
74-
7574
CORS_ORIGIN=https://tracker.nesohq.org
7675
7776
- name: 📝 Generate image summary

docs/QUICKSTART.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,19 @@ Open: `http://localhost:3000`
7979
5. Repositories and issues load.
8080
6. Create or edit an issue to verify write path.
8181

82+
## 5. Docker container run on local machine
83+
84+
1. server
85+
- `docker build --no-cache --network=host -t nesohq-server:local ./server`
86+
- `docker run --rm --env-file server/.env -p 3001:3001 nesohq-server:local`
87+
88+
2. client
89+
- `docker build --no-cache --network=host -t nesohq-client:local --build-arg NEXT_PUBLIC_API_URL=http://localhost:3001 ./client`
90+
- `docker run --rm -p 3000:3000 --name nesohq-client nesohq-client:local`
91+
8292
## Common Setup Notes
8393

8494
- If sign-in fails immediately, verify `GH_CLIENT_ID` and `GH_CLIENT_SECRET`.
8595
- If callback fails, verify OAuth app callback URL and `GH_REDIRECT_URI` alignment.
8696
- If `/api` calls fail with CORS errors, set `CORS_ORIGIN` to frontend origin.
8797
- `client/public/config.js` can override API base URL at runtime for deployed builds.
88-

0 commit comments

Comments
 (0)