Skip to content

Developer Guide

Nick Hamze edited this page Jun 2, 2026 · 1 revision

Developer Guide

Local Commands

Run the app locally:

npm run dev

Build the web assets:

npm run build

Package the macOS app:

npm run package:mac

Open the packaged app:

open "release/Codex Refit.app"

Verification

After server changes:

node --check server.mjs

After Electron changes:

node --check electron/main.mjs

After frontend or bundle changes:

npm run build

After Electron, icon, or packaging changes:

npm run package:mac

General whitespace check:

git diff --check

Backend smoke test when the dev server is running:

curl http://127.0.0.1:5173/api/scan

Packaging

The 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.

Release Checklist

  1. Confirm the working tree only contains intentional changes.
  2. Run node --check server.mjs.
  3. Run git diff --check.
  4. Run npm run build.
  5. Run npm run package:mac.
  6. Open release/Codex Refit.app.
  7. Run a scan and a Speed Check.
  8. Commit and push.
  9. Attach a zipped app build to a GitHub Release when publishing for non-developers.

Repository Notes

  • 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.

Clone this wiki locally