A community based topic aggregation platform built on atproto
bretton.dev
1# Coves Project Structure
2
3This document provides an overview of the Coves project directory structure, following atProto architecture patterns.
4
5**Legend:**
6- 🔒 = Security-sensitive files
7
8```
9Coves/
10├── CLAUDE.md # Project guidelines and architecture decisions
11├── ATPROTO_GUIDE.md # Comprehensive AT Protocol implementation guide
12├── PROJECT_STRUCTURE.md # This file - project structure overview
13├── LICENSE # Project license
14├── README.md # Project overview and setup instructions
15├── go.mod # Go module definition
16├── go.sum # Go module checksums
17│
18├── cmd/ # Application entrypoints
19├── internal/ # Private application code
20│ ├── xrpc/ † # XRPC handlers (atProto API layer)
21│ ├── api/ # Traditional HTTP endpoints (minimal)
22│ ├── core/ # Business logic and domain models
23│ ├── atproto/ # atProto-specific implementations
24│ └── config/ † # Configuration management
25│
26├── db/ # Database layer
27│ ├── appview/ † # AppView PostgreSQL queries
28│ ├── postgres/ # Legacy/non-atProto database operations
29│ ├── migrations/ # Database migrations
30│ ├── local_dev_db_compose/ # Local development database
31│ └── test_db_compose/ # Test database setup
32│
33├── pkg/ # Public packages (can be imported by external projects)
34├── data/ # Runtime data storage
35│ └── carstore/ 🔒 # CAR file storage directory
36│
37├── scripts/ # Development and deployment scripts
38├── tests/ # Integration and e2e tests
39├── docs/ † # Additional documentation
40├── local_dev_data/ # Local development data
41├── test_db_data/ # Test database seed data
42└── build/ † # Build artifacts
43```
44
45
46## Development Guidelines
47
48For detailed implementation guidelines, see [CLAUDE.md](./CLAUDE.md) and [ATPROTO_GUIDE.md](./ATPROTO_GUIDE.md).
49
501. **Start with Lexicons**: Define data schemas first
512. **Implement Core Domain**: Create models and interfaces
523. **Build Services**: Implement business logic
535. **Wire XRPC**: Connect handlers last