Skip to content

Latest commit

 

History

History
120 lines (82 loc) · 2.75 KB

README.md

File metadata and controls

120 lines (82 loc) · 2.75 KB
Raw

ForumAPI System

Back-end web application, programmed in Python and designed to implement a Forum System and provide RESTful API.

Table of contents

Technologies Used

Database: MariaDB

Web Server: Uvicorn

API: FastAPI

Authentication: OAuth2 with JWT

Testing: Unittest

Installation and setup

1. Clone the project using HTTPS

git clone https://github.com/ForumTelerik/forum.git

or SSH

git clone [email protected]:ForumTelerik/forum.git

2. Navigate to forum/server directory and install the packages listed in the requirements.txt file

(Optional) Instructions on creating and activating a virtual environment: Link

pip install -r requirements.txt

3. Start the application (forum/server directory)

uvicorn main:app --reload

4. Swagger docs: Link

Available when you run the server (step 3).

Features

  • Public endpoints - accessible without authentication

  • Login endpoints - require login with username and password; Marked with a lock on Swagger

  • Features, related to users:

    • User register
    • User login
    • View all users
    • Update user's first name and or last name
    • Delete user
    • View single user
    • Change user password

  • Features, related to topic categories:

    • View all categories
    • View single category

  • Features, related to topics:

    • View all topics
    • Create a topic
    • View single topic with its replies
    • Choose best reply to a topic (only topic author)
    • Lock or unlock a topic (a locked topic no longer accepts new replies - only topic author)

  • Features, related to admins:

    • Create a category
    • Make a category public or private
    • Lock or unlock a category (a locked category no longer accepts new topics)
    • Give a user read access to a private category
    • Revoke a user's read access to a private category
    • Give or revoke a user's write access to a private category
    • View all priviliged users for a private category
    • Lock or unlock a topic

  • Features, related to topic replies:

    • Add reply to a topic
    • Edit reply to a topic
    • Delete reply to a topic

  • Features, related to reply votes:

    • Show all votes for reply by type (upvote | downvote)
    • Vote for a reply or switch vote's type
    • Remove vote

  • Features, related to messages:

    • Send message to another user
    • View all messages with another user
    • View all users you've exchanged messages with
    • Edit a message

Database

Database Schema