Skip to content

Commit 05153ce

Browse files
authored
Update docs
1 parent aea74e7 commit 05153ce

File tree

1 file changed

+68
-46
lines changed

1 file changed

+68
-46
lines changed

README.md

Lines changed: 68 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,68 @@
1-
# FastAPI Async Template with PostgreSQL
2-
3-
This is a template for building **asynchronous FastAPI applications** with **PostgreSQL**.
4-
5-
If you're looking to understand the project in depth, please refer to the full documentation here:
6-
👉 [Deep Documentation](https://deepwiki.com/darixsamani/fastapi-postgres) and [Docker Hub Images](https://hub.docker.com/repository/docker/darixsamani/fastapipostgresql/general)
7-
8-
9-
# Features
10-
- Python FastAPI backend
11-
- POSTGRESQL Database
12-
- Docker-Compose
13-
- Authentification
14-
- Migration with Alembic
15-
- PGADMIN4 for Graphical Database Visualization
16-
- Asynchronous
17-
- Support SQLmodel
18-
19-
## Here are the steps to follow to run the program:
20-
After cloning the repository, go to it.
21-
1. DOCKER COMPOSE
22-
```
23-
docker compose up -d --build
24-
25-
```
26-
27-
2. RUN FRIST MIGRATION
28-
```
29-
docker compose exec app uv run alembic revision --autogenerate -m "first migration"
30-
docker compose exec app uv run alembic upgrade head
31-
```
32-
3. Please turn on the LISTEN Docs app. `0.0.0.0:8001/docs`
33-
34-
35-
36-
4. PGADMIN4
37-
38-
access to pgadmin by specified db as name server and 5434 as port at localhost/5050
39-
40-
41-
password: admin
42-
43-
Please turn on the LISTEN Docs app. `0.0.0.0:5050`
44-
45-
5. EXAMPLE
46-
![IMAGE](./img/img.png)
1+
# 🚀 FastAPI Async Template with PostgreSQL
2+
3+
Welcome to the **FastAPI Async Template** — a clean and modern starter for building **asynchronous APIs** powered by **FastAPI** ⚡ and **PostgreSQL** 🐘.
4+
5+
Dive deeper into the full project documentation here:
6+
📚 [Deep Documentation](https://deepwiki.com/darixsamani/fastapi-postgres)
7+
🐳 [Docker Hub Images](https://hub.docker.com/repository/docker/darixsamani/fastapipostgresql/general)
8+
9+
---
10+
11+
## ✨ Features
12+
13+
**FastAPI** — lightning-fast backend framework
14+
🐘 **PostgreSQL** — robust and reliable database
15+
📦 **Docker Compose** — easy setup and environment management
16+
🔐 **Authentication** — secure user handling
17+
⚙️ **Alembic** — smooth database migrations
18+
🧠 **Async Support** — fully asynchronous stack
19+
📊 **PGAdmin4** — visual database management
20+
🧱 **SQLModel** — type-safe ORM integration
21+
22+
---
23+
24+
## 🧭 Quick Start Guide
25+
26+
Follow these simple steps to get your app running in no time ⏱️
27+
28+
### 🐳 1. Start with Docker Compose
29+
30+
```bash
31+
docker compose up -d --build
32+
```
33+
34+
35+
### 🔄 2. Run the First Migration
36+
37+
Initialize and apply your first migration using Alembic 🚀
38+
39+
```
40+
docker compose exec app uv run alembic revision --autogenerate -m "first migration"
41+
docker compose exec app uv run alembic upgrade head
42+
```
43+
44+
### 🌐 3. Access the API Docs
45+
46+
Open the FastAPI interactive docs at:
47+
👉 [http://0.0.0.0:8001/docs](http://0.0.0.0:8001/docs)
48+
49+
50+
51+
### 🗂️ 4. PGAdmin4 Access
52+
53+
Manage your PostgreSQL database visually via PGAdmin4 🎛️
54+
55+
Access URL: [http://localhost:5050](http://localhost:5050)
56+
57+
Server Name: `db`
58+
59+
Port: `5434`
60+
61+
Username: `[email protected]`
62+
63+
Password: `admin`
64+
65+
66+
### 🧩 5. Example Preview
67+
68+
![IMAGE](./img/img.png)

0 commit comments

Comments
 (0)