GitHub Pages Deploy
Why
Devs need to review wireframes asynchronously. The long-term plan is Cloudflare Pages (same as the design site), but the Wire* component dependency makes that non-trivial for now. This is a lightweight temporary solution: generate locally, push to gh-pages branch with a single command.
Objective
Make bob-wire deployable as a static site to GitHub Pages via a manual local workflow — so devs can review wireframes without running a local dev server.
Scope
- Add
gh-pagesas a devDependency - Add a
deployscript topackage.json - Add
app.baseURL: '/bob-wire/'tonuxt.config.ts(required for NuxtLinks to resolve under the subpath) - One-time GitHub Pages setup in repo settings
Outcome
Single npm run deploy command publishes the full static site to qpoint-io.github.io/bob-wire. All wireframe pages browsable without running a local server.
Deploy URL
https://qpoint-io.github.io/bob-wire
Changes
package.json
Add gh-pages devDep and deploy script:
"scripts": {
"deploy": "nuxt generate && gh-pages -d .output/public"
},
"devDependencies": {
"gh-pages": "^6.3.0"
}
nuxt.config.ts
Add baseURL inside the existing app: block:
app: {
baseURL: '/bob-wire/',
head: {
// ... existing head config unchanged
}
}
One-Time GitHub Setup
- Go to
github.com/qpoint-io/bob-wire→ Settings → Pages - Source: Deploy from a branch → branch:
gh-pages, folder:/ (root)
Deploy Workflow (ongoing)
export GITHUB_TOKEN=<your-token> # needed for private layer package install
cd ~/web/qpoint/bob-wire
npm run deploy
The gh-pages package pushes .output/public to the gh-pages branch. GitHub Pages serves from there within ~1 minute.
Status
-
gh-pagesdevDep added -
deployscript added -
app.baseURLadded tonuxt.config.ts - GitHub Pages enabled in repo settings
- First deploy verified at
qpoint-io.github.io/bob-wire