Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (18 loc) · 702 Bytes

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 702 Bytes
Raw

Contributing

Thanks for helping improve Source Admin.

Local Setup

  1. Install Node.js 24 or newer.
  2. Install dependencies with npm install.
  3. Copy .env.example to .env.local.
  4. Create the first local admin account in the browser, or set DEV_AUTH_BYPASS=true for local-only development.
  5. Run npm run dev and open http://localhost:3000/admin/source.

Checks

Run focused checks for the area you changed. For broad changes, run:

npm run typecheck
npm run lint
npm run test
npm run build

Packaging

Use npm run pack:app to build the standalone app that is published with the npm package. Use npm pack --dry-run to inspect package contents before publishing.