https://github.com/sumit0ubey/postapp
PostAPP is a RESTful API built using FastAPI and PostgreSQL. It provides endpoints for creating, reading, updating, and deleting (CRUD) posts. Designed for high performance and scalability, this API leverages FastAPI's asynchronous capabilities for efficient request handling.
https://github.com/sumit0ubey/postapp
fastapi heroku postgres render sqlalchemy
Last synced: 2 months ago
JSON representation
PostAPP is a RESTful API built using FastAPI and PostgreSQL. It provides endpoints for creating, reading, updating, and deleting (CRUD) posts. Designed for high performance and scalability, this API leverages FastAPI's asynchronous capabilities for efficient request handling.
- Host: GitHub
- URL: https://github.com/sumit0ubey/postapp
- Owner: Sumit0ubey
- Created: 2025-03-21T11:45:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-24T14:52:55.000Z (about 1 year ago)
- Last Synced: 2025-06-04T18:18:33.180Z (about 1 year ago)
- Topics: fastapi, heroku, postgres, render, sqlalchemy
- Language: Python
- Homepage: https://postapp-ah7w.onrender.com/docs
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## PostAPP
PostAPP is a RESTful API built using **FastAPI** and **PostgreSQL** to manage posts efficiently. It provides CRUD operations and follows RESTful principles, ensuring high performance and seamless integration.
## Features
- FastAPI-based backend for high-speed API requests
- PostgreSQL for reliable and scalable data storage
- CRUD operations for managing posts
- JSON-based responses for easy frontend integration
- Asynchronous request handling for better performance
## Installation
### Prerequisites
Ensure you have the following installed on your system:
- Python 3.8+
- PostgreSQL
- pip
### Setup
1. Clone the repository:
```bash
git clone https://github.com/Sumit0ubey/PostAPP.git
cd PostAPP
```
2. Create and activate a virtual environment:
```bash
python -m venv venv
source venv/bin/activate # On macOS/Linux
venv\Scripts\activate # On Windows
```
3. Install dependencies:
```bash
pip install -r requirements.txt
```
4. Set up environment variables for PostgreSQL connection:
```bash
export DATABASE_URL="postgresql://username:password@localhost/dbname"
```
5. Run the FastAPI server:
```bash
uvicorn main:app --reload
```
## API Endpoints
| Method | Endpoint | Description |
|--------|---------------|----------------------|
| GET | `/` | Retrieve APP info |
| GET | `/posts` | Retrieve all posts |
| GET | `/posts/{id}` | Get a specific post |
| POST | `/posts` | Create a new post |
| PUT | `/posts/{id}` | Update a post |
| DELETE | `/posts/{id}` | Delete a post |
| PUT | `/likes` |Like a specific posts|
| POST | `/users` | Create a new user |
| GET | `/users/` | Get all user |
| GET | `/users/{id}` | Get a user |
| POST | `/auth/login` | login as a user |
| GET | `/auth/logout`| logout a user |
## Author
Developed by [Sumit dubey](https://github.com/Sumit0ubey).
## Project link
This project is open-source for educational and reference purposes. It is hosted at:
🔗 [Post API](https://postapp-ah7w.onrender.com/docs)