docs: add CLAUDE.md guidance file#1853
Open
claude-im wants to merge 1 commit into
Open
Conversation
Document architecture and common commands for Claude Code: the client/proxy API access pattern, Auth0/Keycloak auth, React Query + Jotai state split, protobuf event stream, typed routes, and the Playwright test project layout. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a
CLAUDE.mdat the repo root to give Claude Code (and new contributors) a fast on-ramp to the codebase. There was no existing one.It focuses on the "big picture" architecture that takes reading several files to piece together, rather than restating discoverable structure or generic practices:
@squonk/data-manager-client/@squonk/account-server-client) pointed at local/api/*-apiproxy routes that inject the Auth0 bearer token server-side, so the token never reaches the browser bundle.buf; don't hand-editsrc/protobuf/gen/.nextjs-routes) and base-path handling.pnpm tscis the real type check (the Next build ignores type/eslint errors); Playwright test projects split by filename suffix; pre-commit hooks; semantic-release;/assetsgit subtree.Notes
--no-verifybecause thepnpm tscpre-commit hook triggers apnpm installthat aborts in a non-TTY shell; nothing in this change affects code or types.🤖 Generated with Claude Code