https://github.com/dibahk/social-media-backend
This project showcases API development using FastAPI, featuring user authentication, database interactions, and a CI/CD pipeline. It emphasizes best practices in API design, including route management, schema validation, and automated testing.
https://github.com/dibahk/social-media-backend
alembic ci-cd docker docker-compose fastapi gcp google-cloud-platform postgresql psycopg2 sqlalchemy
Last synced: 4 months ago
JSON representation
This project showcases API development using FastAPI, featuring user authentication, database interactions, and a CI/CD pipeline. It emphasizes best practices in API design, including route management, schema validation, and automated testing.
- Host: GitHub
- URL: https://github.com/dibahk/social-media-backend
- Owner: dibahk
- Created: 2024-09-02T22:34:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-31T19:11:28.000Z (over 1 year ago)
- Last Synced: 2025-03-27T01:48:29.878Z (over 1 year ago)
- Topics: alembic, ci-cd, docker, docker-compose, fastapi, gcp, google-cloud-platform, postgresql, psycopg2, sqlalchemy
- Language: Python
- Homepage:
- Size: 23.2 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Social Media App Backend with FastAPI
This repository contains a backend for a social media app built using FastAPI. The app provides basic functionality for posts, user management, authentication, and voting (likes). The application is deployed on Google Cloud Platform (GCP) for enhanced scalability and reliability.
## Features
1. **Post Routes**
- Create, update, delete, and retrieve posts.
2. **User Routes**
- Create users and retrieve users by ID.
3. **Auth Routes**
- Manage login and authentication.
4. **Vote Routes**
- Upvote posts.
## Installation
To set up and run the application on your local machine, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/AliAfshar7/FastAPI.git
cd FastAPI
2. **Install dependencies:**
```bash
pip install fastapi[all]
```
3. **Set up the PostgreSQL database and configure environment variables. Create a .env file in the project root.
4. **Run the FastAPI server:**
```bash
uvicorn app.main:app --reload
```
## Database Setup
Ensure PostgreSQL is running.
Create a database and configure the environment variables in the .env file.
The server will start at http://127.0.0.1:8000.
## Technologies Used
This project utilizes a variety of technologies and tools to ensure robust development and deployment:
FastAPI: A modern web framework for building APIs quickly.
PostgreSQL: A powerful, open-source relational database management system.
SQLAlchemy: An SQL toolkit and Object-Relational Mapping (ORM) library for Python.
Pydantic: Data validation and settings management using Python type annotations.
Alembic: A lightweight database migration tool for use with SQLAlchemy.
Uvicorn: A lightning-fast ASGI server to run FastAPI applications.
pytest: A framework for testing Python applications.
Docker: For containerizing the application and its dependencies.
GitHub Actions: To automate CI/CD pipelines.
Google Cloud Platform (GCP): The cloud provider for deployment and hosting.