45 lines
1.5 KiB
Markdown
45 lines
1.5 KiB
Markdown
# FastOrganizer
|
||
|
||
> ⚡ 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
|