Skip to content

Add local setup steps to README#19

Open
CadenLee2 wants to merge 5 commits into
mainfrom
improve-readme
Open

Add local setup steps to README#19
CadenLee2 wants to merge 5 commits into
mainfrom
improve-readme

Conversation

@CadenLee2

@CadenLee2 CadenLee2 commented Jul 20, 2026

Copy link
Copy Markdown

Steps for contributors who need to run locally. The local development/setup experience could be improved in the future to slightly simplify these steps, though that's not a main priority


Summary by cubic

Adds local dev and usage guidance to README so contributors know when to run auth.icssc.club locally and how to onboard new projects (add allowed clients in clients.ts). Also adds pnpm-workspace.yaml to enable local builds for esbuild, sharp, workerd and declares the root package in the workspace.

Covers install/run steps (pnpm i, copy .dev.vars.example, pnpm dev -- --local), Google auth config (update wrangler.jsonc to http://localhost:8787, set GOOGLE_CLIENT_ID/GOOGLE_CLIENT_SECRET, generate a high-entropy HMAC STATE_SIGNING_SECRET), and KV seeding via /jwks.json.

Written for commit 39db5c8. Summary will update on new commits.

Review in cubic

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 20, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
auth 39db5c8 Jul 20 2026, 11:18 PM

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 1 file

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
3. Update `.dev.vars`
- Update `GOOGLE_CLIENT_SECRET` to be yours
- Generate an HMAC key for `STATE_SIGNING_SECRET`
- [Generate](https://www.random.org/strings/) an HMAC key for `STATE_SIGNING_SECRET`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably good enough but might want to tell people to turn on more options

i don't think it matters

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants