Skip to content

Commit bd6b3f6

Browse files
committed
Document package layout in README.md
1 parent 8d9d2b2 commit bd6b3f6

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ For more information on how this works with other frontends/backends, head over
1616
This project is a Python-based API that uses PostgreSQL as its database.
1717
It is built with FastAPI, a modern, fast (high-performance), web framework for building APIs with Python 3 based on standard Python type hints.
1818

19+
## Package layout
20+
- `conduit/api`: HTTP layer (routes, schemas, middlewares)
21+
- `conduit/services`: application services/use-cases
22+
- `conduit/interfaces`: interfaces/abstractions (repositories, service contracts)
23+
- `conduit/dtos`: DTOs used across layers
24+
- `conduit/infrastructure`: SQLAlchemy models, repositories, migrations
25+
- `conduit/core`: config, logging, security, shared utilities
26+
1927
## Prerequisites
2028
- Python 3.12
2129
- FastAPI

0 commit comments

Comments
 (0)