Thank you for your help. Issues and pull requests are welcome.
Open an issue. Tell us:
- what you did,
- what you expected,
- what happened instead (logs or screenshots help).
Do not report security problems in a public issue. Open a private security advisory instead.
You need Node 26, pnpm and your own GitHub OAuth App.
pnpm install
cp .env.example .env.local # set the OAuth client and EMULY_TOKEN_KEY
pnpm db:migrate
pnpm dev # http://localhost:4321OAuth App: callback http://localhost:4321/auth/callback, expiring user tokens on, device flow off.
Checks: pnpm lint, pnpm test, pnpm build.
GET /v1/usage: remaining phone hours and storage.POST /v1/phones: create a phone. Optional body{ "machine": "<name>", "idle_timeout_min": 30 }.POST /v1/webhooks: register a webhook. See docs/WEBHOOKS.md.
- Set
EMULY_TOKEN_KEYto a new key andEMULY_TOKEN_KEY_OLDto the old key. Deploy. - Run
pnpm db:rotate-key. - At 0 failures, remove
EMULY_TOKEN_KEY_OLDand deploy again.
-
Fork the repository and create a branch from
main. -
Keep each pull request small and about one topic.
-
Add or update tests in
lib/**/*.test.tswhen you change behavior. -
Run the checks:
pnpm lint pnpm test pnpm build -
Open a pull request. Explain what changed and why.
- This project uses Next.js 16. Its APIs differ from older versions. Read the docs in
node_modules/next/dist/docs/before you use a Next.js API. - Put schema changes in a new migration in
lib/data/migrations.ts. Never edit an old migration. - Never log tokens, secrets or OAuth codes.
- Encrypt new secret columns with
sealfromlib/auth/crypto.ts, and add them tolib/auth/reencrypt.ts. - Ask GitHub for no OAuth scope beyond
codespaceunless a feature needs it and the user opts in.
By contributing, you agree that your work is licensed under the MIT License.