diff --git a/README.md b/README.md index 18351ea..f9cf423 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,44 @@ # FastOrganizer -the basic conf for fastapi with scalable project and small agile teams. \ No newline at end of file +> ⚑ The basic configuration and project structure boilerplate for FastAPI applications. +> 🎯 Ideal for scalable backend projects and small agile teams. + +--- + +## 🌐 English README + +### What is FastOrganizer? + +**FastOrganizer** is a lightweight, modular project bootstrapper for [FastAPI](https://fastapi.tiangolo.com/) that helps developers and teams start backend development **quickly**, with best practices for **project structure**, **configuration**, **environments**, and **developer experience** in mind. + +It’s inspired by the recurring need to stop reinventing the wheel every time you create a FastAPI backend. + +--- + +### 🎯 Goals + +- Speed up project initialization for FastAPI. +- Encourage scalable and readable project structure. +- Simplify environment-based configuration. +- Serve small teams who need to move fast without compromising code quality. +- Plug-and-play support for database, auth, middleware, CORS, and Swagger docs. + +--- + +### πŸ“ Project Structure + +```bash +. +β”œβ”€β”€ app/ +β”‚ β”œβ”€β”€ api/ # Routes +β”‚ β”œβ”€β”€ core/ # Core logic, config, and startup scripts +β”‚ β”œβ”€β”€ models/ # Pydantic and DB models +β”‚ β”œβ”€β”€ services/ # Business logic +β”‚ β”œβ”€β”€ db/ # Database initialization +β”‚ └── main.py # Entry point +β”‚ +β”œβ”€β”€ tests/ # Pytest tests +β”œβ”€β”€ .env # Local environment variables +β”œβ”€β”€ .env.example # Template for environment variables +β”œβ”€β”€ requirements.txt +└── README.md