DeepTalekar / Basic-Social-Media

FastAPI Backend featuring basic social media features (vote, CRUD posts, users).

Home Page:https://basic-social-media.up.railway.app/docs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Basic Social Media Backend

Github Actions Workflow Status GitHub Production Deployment Status dependency - fastapi view - Documentation Swagger UI Validation Status

Repo Hits Website Hits GitHub repo size PyPI - Python Version

FastAPI backend providing basic social media features

Visit the docs to know more

Note for Docs: Wherever there is the lock πŸ”“ icon you have to be an authorized user (you must be logged in) to make that request.

Features:

Authentication πŸ”

  • User can login using the email and password only

Users πŸ§‘

  • User can be created by following the UserCreate Schema

  • User details can be fetched using the id of the user

Posts πŸ“ƒ

  • User can get all the posts or either few of them with the help of query params:

    • limit: integer - Limit the number of posts by specifying integer values.

    • skip: integer - Applies an offset to the posts and returns the newly resulting posts.

    • search: string(Optional) - Search a post title which contains the search string.

  • User can also create a post by passing JSON object as a parameter following the PostCreate Schema.

  • User can also ask for an individual post.

  • User can only Update/Delete his/her own post(s).

Vote πŸ‘/πŸ‘Ž

  • It is similar to Facebook's Like button functionality.

  • User can vote(like) a post and unvote(dislike) the post that has been voted previously by you.

About

FastAPI Backend featuring basic social media features (vote, CRUD posts, users).

https://basic-social-media.up.railway.app/docs


Languages

Language:Python 98.7%Language:Mako 1.1%Language:Procfile 0.1%