Skip to content

Expand CLAUDE.md with comprehensive project documentation#7

Draft
letam wants to merge 1 commit intomainfrom
claude/add-claude-documentation-Q8XNA
Draft

Expand CLAUDE.md with comprehensive project documentation#7
letam wants to merge 1 commit intomainfrom
claude/add-claude-documentation-Q8XNA

Conversation

@letam
Copy link
Copy Markdown
Owner

@letam letam commented Mar 16, 2026

Summary

Significantly expanded and reorganized the CLAUDE.md documentation file to provide comprehensive guidance for working with the Django + React web framework project. The documentation now covers architecture details, development workflows, code style conventions, project structure, environment configuration, deployment procedures, and middleware stack.

Key Changes

  • Architecture Documentation: Added detailed sections for both backend (Django) and frontend (React + Vite) with specific framework versions, app descriptions, and key API endpoints
  • Development Commands: Reorganized and expanded command reference with quick start instructions, backend/frontend-specific commands, and justfile alternatives
  • Code Style Conventions: Documented Python/Django style rules (Black, isort, Ruff, Google docstrings) and TypeScript/React conventions (Biome, ESLint, shadcn/ui patterns)
  • Testing Guidelines: Added backend and frontend testing frameworks with test locations and base class information
  • Project Structure: Added comprehensive directory tree showing all major directories and key files with descriptions
  • Environment Configuration: Documented all backend and frontend environment variables with examples and use cases
  • Deployment Section: Added Fly.io deployment instructions, Docker multi-stage build details, and GitHub Actions workflow information
  • Middleware Stack: Listed all 10 middleware components in order with brief descriptions
  • Important Notes: Expanded with details about package managers, media processing requirements, authentication approach, CORS configuration, and media streaming features

Notable Details

  • Clarified the role of each Django app (website, users, blogs, uploads, auth) with specific responsibilities
  • Documented API endpoints including authentication, posts CRUD, transcription, and media streaming
  • Specified tool versions (Django 5.2.5, React 19, Vite 6, TypeScript strict mode disabled)
  • Included information about anonymous user support and presigned URL caching
  • Added Open Graph metadata support for social sharing
  • Documented ffmpeg/ffprobe requirements for media processing

https://claude.ai/code/session_018tuPu8ePu2f54p9m3ncVyp

Add detailed architecture info, API endpoints, project structure tree,
environment configuration, deployment docs, and middleware stack details.
Expand app descriptions, testing setup, and development workflow guidance.

https://claude.ai/code/session_018tuPu8ePu2f54p9m3ncVyp
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