|
1 | | -# 🚀 FastAPI-Forge |
2 | | -⚡ UI Based FastAPI Project Generator |
| 1 | +# FastAPI-Forge |
| 2 | +UI Based FastAPI Project Generator |
3 | 3 |
|
4 | | -✨ *Define your database models through a UI, select services, and get a complete production-ready containerized project with tests and endpoints!* |
| 4 | +*Define your database models through a UI, select services, and get a complete production-ready containerized project with tests and endpoints!* |
5 | 5 |
|
6 | 6 |
|
7 | | -## 🔥 Features |
| 7 | +## Features |
8 | 8 |
|
9 | 9 |
|
10 | | -### 🖌️ UI Power |
11 | | -- 🖥️ [NiceGUI](https://github.com/zauberzeug/nicegui)-based interface for project design |
12 | | -- 📊 Visual model creation and configuration |
13 | | -- ✅ Checkbox additional services to be integrated |
14 | | -- 🚀 Quick-add common fields |
15 | | -- ⚙️ One-click project generation |
| 10 | +### UI Power |
| 11 | +- [NiceGUI](https://github.com/zauberzeug/nicegui)-based interface for project design |
| 12 | +- Visual model creation and configuration |
| 13 | +- Checkbox additional services to be integrated |
| 14 | +- Quick-add common fields |
| 15 | +- One-click project generation |
16 | 16 |
|
17 | | -### ⚡ Auto-Generated Components |
18 | | -- 🗄️ [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy) Models |
19 | | -- 📦 [Pydantic](https://github.com/pydantic/pydantic) Schemas |
20 | | -- 🌐 RESTful Endpoints (CRUD + more) |
21 | | -- 🧪 Comprehensive Test Suite (pytest) |
22 | | -- 🏗️ DAOs (Database Access Objects) |
23 | | -- 🏭 [Factory Boy](https://github.com/FactoryBoy/factory_boy) Test Factories |
24 | | -- 🐳 [Docker Compose](https://github.com/docker/compose) Setup |
| 17 | +### Auto-Generated Components |
| 18 | +- [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy) Models |
| 19 | +- [Pydantic](https://github.com/pydantic/pydantic) Schemas |
| 20 | +- RESTful Endpoints (CRUD + more) |
| 21 | +- Comprehensive Test Suite (pytest) |
| 22 | +- DAOs (Database Access Objects) |
| 23 | +- [Factory Boy](https://github.com/FactoryBoy/factory_boy) Test Factories |
| 24 | +- [Docker Compose](https://github.com/docker/compose) Setup |
25 | 25 |
|
26 | | -### 🎛️ Advanced Features |
27 | | -- 🎚️ Custom Enum support as data types |
28 | | -- 📥 YAML project import/export |
29 | | -- 🐘 Convert existing databases into FastAPI projects via connection string! |
| 26 | +### Advanced Features |
| 27 | +- Custom Enum support as data types |
| 28 | +- YAML project import/export |
| 29 | +- Convert existing databases into FastAPI projects via connection string! |
30 | 30 | - Basically lets you quickly create an API for any database. |
31 | 31 |
|
32 | | -### 🔄 CI/CD Automation |
33 | | -- ⚙️ GitHub Workflows for automated testing and linting |
34 | | - - 🧪 Runs pytest suite |
35 | | - - ✨ Executes code formatting checks |
36 | | - - ✅ Ensures code quality before merging |
| 32 | +### CI/CD Automation |
| 33 | +- GitHub Workflows for automated testing and linting |
| 34 | + - Runs pytest suite |
| 35 | + - Executes code formatting checks |
| 36 | + - Ensures code quality before merging |
37 | 37 |
|
38 | | -## 🧩 Optional Integrations |
| 38 | +## Optional Integrations |
39 | 39 |
|
40 | 40 | | Category | Technologies | |
41 | 41 | |----------------|---------------------------------------| |
|
56 | 56 |
|
57 | 57 |
|
58 | 58 |
|
59 | | -## ✅ Requirements |
| 59 | +## Requirements |
60 | 60 | - Python 3.12+ |
61 | 61 | - UV |
62 | 62 | - Docker and Docker Compose (for running the generated project) |
63 | 63 |
|
64 | 64 |
|
65 | | -## 🚀 Quick Start |
| 65 | +## Quick Start |
66 | 66 | Install FastAPI-Forge: |
67 | 67 |
|
68 | 68 | ```bash |
@@ -90,7 +90,7 @@ make up # Builds and runs your project along with additional services |
90 | 90 | - Access the SwaggerUI/OpenAPI docs at: `http://localhost:8000/docs`. |
91 | 91 |
|
92 | 92 |
|
93 | | -## ⚙️ Command Options |
| 93 | +## Command Options |
94 | 94 | Customize your project generation with these options: |
95 | 95 |
|
96 | 96 | ### `--use-example` |
@@ -128,7 +128,7 @@ fastapi-forge start --from-yaml=~/Documents/project-config.yaml --no-ui |
128 | 128 | ``` |
129 | 129 |
|
130 | 130 |
|
131 | | -## 🧰 Using the Makefile |
| 131 | +## Using the Makefile |
132 | 132 | The generated project includes a `Makefile` to simplify common dev tasks: |
133 | 133 |
|
134 | 134 | ### Start the Application |
@@ -157,7 +157,7 @@ make lint |
157 | 157 |
|
158 | 158 | --- |
159 | 159 |
|
160 | | -## 📦 Database Migrations with Alembic |
| 160 | +## Database Migrations with Alembic |
161 | 161 | If you chose Alembic for migrations during project setup, these commands will help manage your database schema: |
162 | 162 |
|
163 | 163 | ### Generate a New Migration |
|
0 commit comments