-
Notifications
You must be signed in to change notification settings - Fork 0
Developer Guide
Nick Hamze edited this page Jun 2, 2026
·
1 revision
Run the app locally:
npm run devBuild the web assets:
npm run buildPackage the macOS app:
npm run package:macOpen the packaged app:
open "release/Codex Refit.app"After server changes:
node --check server.mjsAfter Electron changes:
node --check electron/main.mjsAfter frontend or bundle changes:
npm run buildAfter Electron, icon, or packaging changes:
npm run package:macGeneral whitespace check:
git diff --checkBackend smoke test when the dev server is running:
curl http://127.0.0.1:5173/api/scanThe package script writes the app bundle to:
release/Codex Refit.app
The app icons live in:
electron/
public/app-icons/
Do not replace generated image assets or app icons unless that is the explicit task.
- Confirm the working tree only contains intentional changes.
- Run
node --check server.mjs. - Run
git diff --check. - Run
npm run build. - Run
npm run package:mac. - Open
release/Codex Refit.app. - Run a scan and a Speed Check.
- Commit and push.
- Attach a zipped app build to a GitHub Release when publishing for non-developers.
- Generated images are move-only in app behavior.
- Never add a cleanup path that deletes generated images.
- Keep public README copy simple and non-developer-facing.
- Put implementation notes and diagnostic detail in this wiki.