An advanced REST API written in Python for a generic social media website
Go to file
Mattia Giambirtone 1d1f2368fe
2023-03-13 15:59:03 +01:00
src Refactoring 2023-03-13 15:59:03 +01:00
templates/email Added support for various types of email verification and email templates 2022-10-05 12:30:21 +02:00
.gitignore Updated .gitignore and removed .idea directory 2022-10-04 21:14:26 +02:00 Minor documentation improvements 2022-10-06 17:20:54 +02:00
LICENSE Initial commit 2022-10-04 20:58:27 +02:00 Minor changes to README 2022-10-05 12:33:33 +02:00
requirements.txt Large rework of the application for better documentation support 2022-10-05 19:52:37 +02:00


An advanced REST API written in Python for a generic social media website.

Note: This is a WIP so far.

Tech Stack

The project is written using FastAPI, piccolo and uvicorn. Other awesome libraries used (only direct dependencies are listed here):

Feature overview

Note: Not all of this is implemented yet

  • Simple authentication system using salted bcrypt hashes for password storage
  • Integrated email system with verification support (optional)
  • Integrated database using PostgreSQL as a backend
  • Simple rate limiting using redis/in-memory storage
  • Support for various kinds of media stored in a CDN, directly inside the database or on a local/remote filesystem
  • Regular social media mechanics: (Un)following users, posting media with captions, stories, etc.
  • User settings (change username, email, bio, password, profile picture, etc.)
  • Simple messaging system using websockets or a polling HTTP API
  • Admin functionality with basic metrics and administration features (flagging/deleting users/posts, handling tickets, etc.)

Note: For security reasons, password and email changes require an email confirmation. Changing the email also forces the user to verify the new address again.


Move the *.py.example files to their respective *.py files, fill them as necessary, then simply install the dependencies via pip and run


This software is licensed under the MIT license. For more information, read the license file