Skip to content

Commit 0f33596

Browse files
committed
docs: updated readme with screenshot
1 parent d0ea236 commit 0f33596

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,19 @@
22

33
Welcome to the FastAPI project! Follow these instructions to set up the project on your local machine and get everything running smoothly.
44

5+
## Project Overview
6+
7+
This FastAPI project is a learning tool and development playground where I am building various app modules to deepen my understanding of FastAPI. The project starts with a blog feature, and I plan to expand it with additional apps as I continue to learn and explore FastAPI's capabilities.
8+
9+
![API Documentation](assets/screenshot.jpeg)
10+
511
## Prerequisites
612

713
Before you begin, the project assumes the following:
814

915
- A Linux environment, or WSL (if using Windows)
1016
- Python 3.10 or later installed.
17+
- PostgreSQL installed.
1118

1219
A Makefile has been provided for easy project setup.
1320

@@ -69,7 +76,9 @@ A Makefile has been provided for easy project setup.
6976
make run
7077
```
7178

72-
You can then view the API docs at `http://127.0.0.1:8000/docs/`.
79+
The API documentation is available at `http://127.0.0.1:8000/docs/`.
80+
81+
Or if you prefer using Redocly, at `http://127.0.0.1:8000/redoc`
7382

7483
- **Cleaning Up**
7584

assets/screenshot.jpeg

99.8 KB
Loading

0 commit comments

Comments
 (0)