nocturn9x
/
PySimpleSocial
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Minor changes to README

This commit is contained in:
Nocturn9x 2022-10-05 12:33:33 +02:00
parent e0f99668a3
commit f1d04112d7
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -20,14 +20,18 @@ The project is written using [FastAPI](https://https://fastapi.tiangolo.com/), [
__Note__: Not all of this is implemented yet
- Simple authentication system using salted bcrypt hashes for password storage
- PostgreSQL is used as the main database
- 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, etc.
- User settings (change username, profile picture, etc.)
- 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.
# Setup
Move the *.py.example files to their respective *.py files, fill them as necessary, then simply install the dependencies via pip and run main.py