Skip to content

README.md

Latest commit

 

History

History
77 lines (51 loc) · 2.08 KB

README.md

File metadata and controls

77 lines (51 loc) · 2.08 KB
Raw

CardBoxGen Web App

This folder is the static GitHub Pages app.

Runtime files:

  • index.html
  • app.js
  • style.css
  • i18n/*.json
  • cardboxgen_bundle.py generated by python tools/sync_docs.py
  • fabrication_model.md
  • geometry_hardening_audit.md
  • camera_qr_sharing.md
  • wiki/*.md versioned GitHub-wiki source pages

The app loads Pyodide in the browser and imports cardboxgen_bundle.py. No backend is required. Export is disabled when Python validation reports blocking geometry errors.

The app also supports project handoff without a backend:

  • share links with cfg=...;
  • pasteable CBG1: project/location codes;
  • optional QR scanning when the browser grants camera permission;
  • /exec/ redirect for direct browser launch.

If camera permission is blocked, use the project code fallback. See camera_qr_sharing.md.

The wiki/ folder contains wiki-ready Markdown pages:

  • Home.md
  • Template-Reference.md
  • Validation-and-Testing.md
  • CLI-and-Python-API.md
  • Fabrication-Model.md
  • Camera-QR-and-Project-Codes.md
  • Running-and-Deployment.md
  • Contributing.md

If the GitHub wiki repository has not been initialized yet, create its first page in the GitHub UI, then copy or push these pages to the wiki repository.

Local Preview

From the repo root:

python tools/sync_docs.py
python -m http.server 8000

Open http://localhost:8000/docs/.

Freshness Check

python tools/sync_docs.py --check

This fails if docs/cardboxgen_bundle.py no longer matches the package source.

Fabrication Notes

CardBoxGen treats kerf as the full width removed by the cut and stores the computed burn radius, tab/slot fit values, and validation limits in SVG metadata. See fabrication_model.md for the sign convention and calibration workflow.

GitHub Pages

The Pages workflow uploads docs/ as the deploy artifact. In GitHub repository settings:

  • Settings -> Pages
  • Source: GitHub Actions

Live app:

https://sunnydesigntech.github.io/CardBoxGen/

Direct execution/classroom launcher entry:

https://sunnydesigntech.github.io/CardBoxGen/exec/