README.md Güncelle

This commit is contained in:
Bedir Tuğra Karaabalı 2025-06-02 03:01:57 +00:00
parent 2e323a58d3
commit 9c6a2726c5

View File

@ -1,3 +1,44 @@
# FastOrganizer
the basic conf for fastapi with scalable project and small agile teams.
> ⚡ 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.
Its 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