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- † = Planned but not yet implemented
7- 🔒 = Security-sensitive files
8
9```
10Coves/
11├── CLAUDE.md # Project guidelines and architecture decisions
12├── ATPROTO_GUIDE.md # Comprehensive AT Protocol implementation guide
13├── PROJECT_STRUCTURE.md # This file - project structure overview
14├── LICENSE # Project license
15├── README.md # Project overview and setup instructions
16├── go.mod # Go module definition
17├── go.sum # Go module checksums
18│
19├── cmd/ # Application entrypoints
20├── internal/ # Private application code
21│ ├── xrpc/ † # XRPC handlers (atProto API layer)
22│ ├── api/ # Traditional HTTP endpoints (minimal)
23│ ├── core/ # Business logic and domain models
24│ ├── atproto/ # atProto-specific implementations
25│ └── config/ † # Configuration management
26│
27├── db/ # Database layer
28│ ├── appview/ † # AppView PostgreSQL queries
29│ ├── postgres/ # Legacy/non-atProto database operations
30│ ├── migrations/ # Database migrations
31│ ├── local_dev_db_compose/ # Local development database
32│ └── test_db_compose/ # Test database setup
33│
34├── pkg/ # Public packages (can be imported by external projects)
35├── data/ # Runtime data storage
36│ └── carstore/ 🔒 # CAR file storage directory
37│
38├── scripts/ # Development and deployment scripts
39├── tests/ # Integration and e2e tests
40├── docs/ † # Additional documentation
41├── local_dev_data/ # Local development data
42├── test_db_data/ # Test database seed data
43└── build/ † # Build artifacts
44```
45
46## Implementation Status
47
48### Completed ✓
49- Basic repository structure
50- User domain models
51- CAR store foundation
52- Lexicon schemas
53- Database migrations
54
55### In Progress 🚧
56- Repository service implementation
57- User service
58- Basic authentication
59
60### Planned 📋
61- XRPC handlers
62- AppView indexer
63- Firehose implementation
64- Community features
65- Moderation system
66- Feed algorithms
67
68## Development Guidelines
69
70For detailed implementation guidelines, see [CLAUDE.md](./CLAUDE.md) and [ATPROTO_GUIDE.md](./ATPROTO_GUIDE.md).
71
721. **Start with Lexicons**: Define data schemas first
732. **Implement Core Domain**: Create models and interfaces
743. **Build Services**: Implement business logic
754. **Add Repositories**: Create data access layers
765. **Wire XRPC**: Connect handlers last