-
Notifications
You must be signed in to change notification settings - Fork 231
ENG-8946: Add CLAUDE.md #1767
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
ENG-8946: Add CLAUDE.md #1767
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # CLAUDE.md | ||
|
|
||
| ## What is this project? | ||
|
|
||
| The official Reflex website (reflex.dev) — built with Reflex itself. Includes docs, blog, pricing, landing pages, and customer showcases. Serves as both the public-facing site and a real-world example of a production Reflex app. | ||
|
|
||
| ## Tech stack | ||
|
|
||
| - **Framework:** Reflex (Python full-stack) | ||
| - **Styling:** Tailwind CSS v4 with Radix UI color system | ||
| - **Package manager:** UV (`uv sync` to install deps) | ||
| - **Linting:** Ruff, Codespell — enforced via pre-commit | ||
|
|
||
| ## Project layout | ||
|
|
||
| ``` | ||
| pcweb/ # Main application code | ||
| pcweb.py # App entry point | ||
| whitelist.py # Dev mode: limits which pages are compiled (faster builds) | ||
| pages/ # All page routes (docs/, blog/, landing/, pricing/, etc.) | ||
| components/ # Reusable UI components | ||
| views/ # Shared view components (navbar, footer, cta) | ||
| templates/ # Page templates (docpage, mainpage) | ||
| meta/ # SEO meta tags | ||
| docs/ # Markdown documentation (flexdown) | ||
| blog/ # Blog posts (markdown + frontmatter) | ||
| tests/ # Pytest + Playwright tests | ||
| ``` | ||
|
|
||
| ## Commands | ||
|
|
||
| | Task | Command | | ||
| |------|---------| | ||
| | Install deps | `uv sync` | | ||
| | Run dev server | `uv run reflex run` | | ||
| | Run prod | `uv run reflex run --env prod` | | ||
| | Compile check | `uv run reflex compile` | | ||
| | Run tests | `uv run pytest tests/` | | ||
| | Install Playwright (if tests fail) | `uv run playwright install` | | ||
| | Lint / format | `uv run pre-commit run --all-files` | | ||
|
|
||
| ## Dev mode: page whitelist | ||
|
|
||
| `pcweb/whitelist.py` limits which pages are compiled in dev mode for faster builds. Empty list = build all. See `pcweb/whitelist.py` for format; paths start with `/`, no trailing slash. | ||
|
|
||
| ## Code patterns | ||
|
|
||
| - **Components:** shared components for the app — see `pcweb/components/` | ||
| - **Pages:** use `@mainpage` or `@docpage` decorators — see `pcweb/pages/`, `pcweb/templates/` | ||
| - **Imports:** absolute from project root — `from pcweb.components.button import button` | ||
| - **Elements:** use `rx.el.*` with Tailwind (not `rx.box`, `rx.text`) | ||
|
|
||
| ## Key conventions | ||
|
|
||
| - Docs: flexdown in `docs/` | ||
| - Blog: flexdown in `blog/` | ||
| - Before committing: `uv run reflex compile` and `uv run pre-commit run --all-files` | ||
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.
Uh oh!
There was an error while loading. Please reload this page.