From 7d96a657b3e5197826e02a2b74cd9694fb2f0b53 Mon Sep 17 00:00:00 2001 From: Markus Graf Date: Fri, 21 Nov 2025 20:38:08 +0100 Subject: [PATCH] docs: update project structure in README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Expand the project structure section to include all directories and files with detailed descriptions. The updated structure now shows: - Complete src/ layout with all modules - Test suite organization (unit, integration, e2e, mcp) - Migration and script directories - OpenSpec structure with all spec categories - Configuration files 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- README.md | 40 ++++++++++++++++++++++++++++++++++------ 1 file changed, 34 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ec04a65..01410f9 100644 --- a/README.md +++ b/README.md @@ -35,12 +35,40 @@ The system consists of two main components: ``` clubber/ -├── openspec/ # Specification-driven development -│ ├── project.md # Project conventions and context -│ ├── specs/ # Current specifications -│ └── changes/ # Change proposals -├── CLAUDE.md # AI assistant instructions -└── README.md # This file +├── src/ # Application source code +│ ├── models/ # SQLAlchemy database models +│ ├── resolvers/ # GraphQL resolvers (queries and mutations) +│ ├── schemas/ # GraphQL schema definitions +│ ├── config.py # Application configuration +│ ├── database.py # Database setup and session management +│ ├── main.py # FastAPI application entry point +│ ├── mcp_server.py # MCP server implementation +│ └── validation.py # Input validation logic +├── tests/ # Test suite +│ ├── unit/ # Unit tests (validation logic) +│ ├── integration/ # Integration tests (database, resolvers) +│ ├── e2e/ # End-to-end tests (API flows) +│ ├── mcp/ # MCP server tests +│ └── conftest.py # Shared test fixtures +├── migrations/ # Alembic database migrations +│ └── versions/ # Migration version files +├── scripts/ # Utility scripts +│ └── seed.py # Database seeding script +├── openspec/ # Specification-driven development +│ ├── specs/ # Current specifications +│ │ ├── database-layer/ +│ │ ├── graphql-api/ +│ │ ├── mcp-integration/ +│ │ ├── member-crud/ +│ │ ├── project-documentation/ +│ │ └── project-setup/ +│ └── changes/ # Change proposals +│ └── archive/ # Archived completed changes +├── pyproject.toml # Project dependencies and configuration +├── alembic.ini # Alembic migration configuration +├── uv.lock # Locked dependency versions +├── CLAUDE.md # AI assistant instructions +└── README.md # This file ``` ## Getting Started