Skip to content

Commit 74084dd

Browse files
authored
Update README.md
1 parent 2415693 commit 74084dd

1 file changed

Lines changed: 5 additions & 31 deletions

File tree

README.md

Lines changed: 5 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# FastAPI-Forge
22
🚀 Build FastAPI Projects — Fast, Scalable, and Hassle-Free!
33

4-
FastAPI-Forge lets you define your database models through a UI, letting you select additional optional services, and then generates a full working project for you.
5-
The generated project follows best practices, in an easy to work with and scalable architecture. It will contain SQLAlchemy models of the database models you've defined in the UI, along with implementations of your selected services.
6-
It makes use of the DAO and DTO pattern, in combination with Pydantic and SQLAlchemy.
7-
Optionally, you can choose to generate tests, endpoints, DAOs and DTOs for each model.
4+
FastAPI-Forge lets you define your database models through a UI, letting you select additional optional services, and then generates a full working project for you, with tests and endpoints.
5+
The generated project follows best practices, in an easy-to-work with and scalable architecture. It will contain SQLAlchemy models of the database models you've defined in the UI, along with implementations of your selected services.
86

97
---
108

@@ -34,11 +32,6 @@ fastapi-forge start
3432
- Define your database schema and service specifications.
3533
- Once done, click `Generate` to build your API.
3634

37-
Example generated project:
38-
39-
![image](https://github.com/user-attachments/assets/e52eecf1-cce9-4edb-988c-c9e3c14d5712)
40-
41-
4235
To start the generated project and its dependencies in Docker:
4336

4437
```bash
@@ -61,38 +54,19 @@ fastapi-forge start --use-example
6154
```
6255

6356
### `--no-ui`
64-
Skip the web UI and generate your project directly from the terminal — perfect for headless environments or CLI-first workflows:
57+
Skip the web UI and generate your project directly from the terminal:
6558

6659
```bash
6760
fastapi-forge start --no-ui
6861
```
6962

7063
### `--from-yaml`
71-
Load a custom YAML configuration and either generate the project immediately (with `--no-ui`) or review and adjust it in the UI:
64+
Load a custom YAML configuration (can be generated through the UI):
7265

7366
```bash
7467
fastapi-forge start --from-yaml=~/path/to/config.yaml
7568
```
7669

77-
---
78-
79-
## 🧑‍💻 Examples
80-
81-
### Use an Example Template
82-
```bash
83-
fastapi-forge start --use-example
84-
```
85-
86-
### Generate a Project Without the UI
87-
```bash
88-
fastapi-forge start --no-ui
89-
```
90-
91-
### Generate a Project from a YAML Configuration
92-
```bash
93-
fastapi-forge start --from-yaml=~/Documents/project-config.yaml
94-
```
95-
9670
### Combine Options
9771
Load a YAML config and skip the UI:
9872
```bash
@@ -110,7 +84,7 @@ make up
11084
```
11185

11286
### Run Tests
113-
Tests are automatically generated based on your schema — no need to write them from scratch. Once the app is running (`make up`):
87+
Tests are automatically generated based on your schema. Once the app is running (`make up`):
11488

11589
```bash
11690
make test

0 commit comments

Comments
 (0)