https://github.com/shahidmalik4/fastapi-html
A lightweight blog application built with FastAPI, supporting user authentication, HTML server-side rendering, and full CRUD functionality for blog posts.
https://github.com/shahidmalik4/fastapi-html
blog fastapi html python sqlalchemy
Last synced: 5 days ago
JSON representation
A lightweight blog application built with FastAPI, supporting user authentication, HTML server-side rendering, and full CRUD functionality for blog posts.
- Host: GitHub
- URL: https://github.com/shahidmalik4/fastapi-html
- Owner: shahidmalik4
- Created: 2025-07-18T06:43:00.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-07-19T11:41:48.000Z (11 months ago)
- Last Synced: 2025-07-19T16:15:39.818Z (11 months ago)
- Topics: blog, fastapi, html, python, sqlalchemy
- Language: Python
- Homepage:
- Size: 40 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📝 FastAPI Blog App with Server-Side HTML Rendering
[](https://www.python.org/)
[](https://fastapi.tiangolo.com/)
[](./LICENSE)
[](#)
A full-featured blog application built with **FastAPI**, **Jinja2**, and **SQLAlchemy**. Supports server-side HTML rendering, user authentication, flash messaging, and full CRUD functionality — all with clean modular code and session-based route protection.
---
## 🚀 Features
- 🔐 User registration, login, and logout
- ⚡ Session-based authentication using secure cookies
- 💬 Flash messages for user feedback
- 📝 Create, Read, Update, Delete (CRUD) blog posts
- 🔗 Slug generation for posts
- 🧰 FastAPI + Jinja2 HTML templating
- 🧱 SQLite database (easy to swap out)
- 🛡️ Protected routes (dashboard, create post, etc.)
- 🗃️ Clean, modular architecture (auth, crud, schemas, models)
- 🚀 Deployable on **Render**, **Heroku**, or **any ASGI server**
---
## 🧰 Tech Stack
- **Framework**: [FastAPI](https://fastapi.tiangolo.com/)
- **ORM**: SQLAlchemy
- **Templates**: Jinja2
- **Schema Validation**: Pydantic
- **Database**: SQLite (can be upgraded to PostgreSQL/MySQL)
- **Web Server**: Uvicorn
---
## 📁 Project Structure
```
fastapi-html/
├── app/
│ ├── auth.py # Auth routes (register, login, logout)
│ ├── crud.py # Post/user CRUD logic
│ ├── database.py # SQLAlchemy DB connection
│ ├── deps.py # Dependency overrides and helpers
│ ├── main.py # App entry point
│ ├── models.py # SQLAlchemy models
│ ├── schemas.py # Pydantic schemas
│ ├── templates/ # HTML templates
│ └── utils.py # Flash messaging & helpers
├── blog_app.db # SQLite DB file
├── requirements.txt # Python dependencies
├── render.yml # Render deployment config
└── README.md # You're reading it!
```
---
## 📦 Installation
```bash
# Clone the repository
git clone https://github.com/shahidmalik4/fastapi-html.git
cd fastapi-html
# Create and activate a virtual environment
python -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt
# Run the server
uvicorn app.main:app --reload
```
---
## 🔐 Auth Flow
- `/register`: Register new user
- `/login`: Login page (sets session)
- `/logout`: Logout and clear session
- Routes like `/dashboard` and `/create-post` are protected and require login
---
## 🧑💻 CRUD Endpoints
| Route | Method | Auth Required | Description |
|-------------------|--------|---------------|--------------------------|
| `/register` | GET/POST | ❌ | Register a new user |
| `/login` | GET/POST | ❌ | Login with credentials |
| `/logout` | GET | ✅ | Logout user |
| `/dashboard` | GET | ✅ | View user dashboard |
| `/create-post` | GET/POST | ✅ | Create a new post |
| `/edit-post/{id}` | GET/POST | ✅ | Edit an existing post |
| `/delete-post/{id}`| GET | ✅ | Delete a post |
| `/post/{slug}` | GET | ✅ | View a single post |
---
## 🧾 Models
```python
🧍 User (SQLAlchemy)
📝 Post (SQLAlchemy)
```
---
## 📦 Pydantic Schemas
```python
class UserCreate(BaseModel):
class UserOut(BaseModel):
class PostBase(BaseModel):
class PostCreate(PostBase):
class PostOut(PostBase):
```
---
## 📤 Deployment (Render Example)
`render.yml` already included for Render deployment.
> You can also deploy using Docker, Heroku, or any ASGI-compatible cloud.
---