agentleFS
Sign inStart free
behradkhodayarbehradkhodayar/claude-code-py-ts-pg/CLAUDE.md

claude-code-py-ts-pg

CLAUDE.md1 starsChanged 5 months agoMITView on GitHub

Polyglot full-stack app: Python/FastAPI backend, TypeScript/React frontend, PostgreSQL in Docker. This file loads every session — keep it short. Language- and path-specific detail lives in .claude/rules/ and loads on demand. - Never edit the database schema by hand. Add an Alembic migration (make revision). - Never commit secrets. Config comes from env vars; .env is gitignored, .env.example is the contract. - Keep the API and web app decoupled — the only coupling is the HTTP contract in apps/web/src/api.ts. - Tests…

  • Reads credentials

The file

We split this CLAUDE.md into the rules it gives an agent

5 rules. About 0 are common, 1 is distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Very specific:

    Start stack: make up · Stop: make down · Logs: make logs

    line 9
  2. Very specific:

    Test everything: make test · Lint: make lint · Format: make fmt

    line 10
  3. Very specific:

    Never edit the database schema by hand: Add an Alembic migration (make revision).

    line 24
  4. Very specific:

    Keep the API and web app decoupled — the only coupling is the HTTP contract in apps/web/src/api.ts.

    line 26
  5. Distinctive:

    Follow the branch → PR → review → squash-merge flow.

    line 28

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
CLAUDE.md

Project conventions

Polyglot full-stack app: Python/FastAPI backend, TypeScript/React frontend, PostgreSQL in Docker. This file loads every session — keep it short. Language- and path-specific detail lives in .claude/rules/ and loads on demand.

Commands (always prefer the Makefile)

  • Start stack: make up · Stop: make down · Logs: make logs
  • Test everything: make test · Lint: make lint · Format: make fmt
  • DB migrate: make migrate · New migration: make revision m="msg" · Reset: make db-reset
  • Backend only: make api-test, make api-lint
  • Frontend only: make web-test, make web-lint

Architecture

  • apps/api — FastAPI service. Owns the database schema via Alembic migrations.
  • apps/web — React + Vite SPA. Talks to the API over HTTP; never touches the DB directly.
  • db — PostgreSQL 17, run through Docker Compose. Schema changes go through Alembic, never manual SQL.
  • The API is the single source of truth for data; the web app is a pure client.

Ground rules

  • Never edit the database schema by hand. Add an Alembic migration (make revision).
  • Never commit secrets. Config comes from env vars; .env is gitignored, .env.example is the contract.
  • Keep the API and web app decoupled — the only coupling is the HTTP contract in apps/web/src/api.ts.
  • Tests live next to the code they cover (test_*.py for Python, *.test.tsx for TS).
  • Follow the branch → PR → review → squash-merge flow; never push directly to main.
  • Third-party skills are untrusted code: vet with make skills-scan and see docs/ecosystem.md before adopting any.

When you touch...

  • Python (apps/api/**) → the Python rule loads automatically. Use uv, ruff, type hints.
  • TypeScript (apps/web/**) → the TS rule loads. Named exports, strict mode, no any.
  • Migrations / SQL → the database rule loads. Reversible migrations only.
  • Docker / compose → the docker rule loads.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free