diff --git a/README.md b/README.md index eb71d615..6e34ec4f 100644 --- a/README.md +++ b/README.md @@ -14,39 +14,6 @@ Our folder structure for the APIs: ``` fastapi-project ├── migrations/ -├── src -│ ├── auth -│ │ ├── router.py # auth main router with all the endpoints -│ │ ├── schemas.py # pydantic models -│ │ ├── models.py # database models -│ │ ├── dependencies.py # router dependencies -│ │ ├── config.py # local configs -│ │ ├── constants.py # module-specific constants -│ │ ├── exceptions.py # module-specific errors -│ │ ├── service.py # module-specific business logic -│ │ └── utils.py # any other non-business logic functions -│ ├── aws -│ │ ├── client.py # client model for external service communication -│ │ ├── schemas.py -│ │ ├── config.py -│ │ ├── constants.py -│ │ ├── exceptions.py -│ │ └── utils.py -│ └── posts -│ │ ├── router.py -│ │ ├── schemas.py -│ │ ├── models.py -│ │ ├── dependencies.py -│ │ ├── constants.py -│ │ ├── exceptions.py -│ │ ├── service.py -│ │ └── utils.py -│ ├── config.py # global configs -│ ├── models.py # global database models -│ ├── exceptions.py # global exceptions -│ ├── pagination.py # global module e.g. pagination -│ ├── database.py # db connection related stuff -│ └── main.py ├── tests/ │ ├── auth │ ├── aws @@ -57,6 +24,37 @@ fastapi-project │ ├── base.txt │ ├── dev.txt │ └── prod.txt +├── router.py # auth main router with all the endpoints +├── schemas.py # pydantic models +├── models.py # database models +│ ├── dependencies.py # router dependencies +│ ├── config.py # local configs +│ ├── constants.py # module-specific constants +│ ├── exceptions.py # module-specific errors +│ ├── service.py # module-specific business logic +│ └── utils.py # any other non-business logic functions +├── aws +│ ├── client.py # client model for external service communication +│ ├── schemas.py +│ ├── config.py +│ ├── constants.py +│ ├── exceptions.py +│ └── utils.py +└── posts +│ ├── router.py +│ ├── schemas.py +│ ├── models.py +│ ├── dependencies.py +│ ├── constants.py +│ ├── exceptions.py +│ ├── service.py +│ └── utils.py +├── config.py # global configs +├── models.py # global database models +├── exceptions.py # global exceptions +├── pagination.py # global module e.g. pagination +├── database.py # db connection related stuff +├── main.py ├── .env ├── .gitignore ├── logging.ini