Codebase for HackThis 2020 Submission: Classroom Plus

ClientBot

A simple chatroom to pose questions and upvote, downvote, or comment on them.

Running Locally

ClientBot and Quiz

(venv) % python flask_start.py

The API is created at http://localhost:9874. Query with an app like Insomnia.

Icebreaker

% cd icebreaker
% go run main.go

Pushing to Heroku

ClientBot and Quiz

% git commit
% git push heroku master

Icebreaker

% cd icebreaker
% go mod vendor
% go build -i -o ./bin/icebreaker
% git commit
% git push heroku master

API Endpoints

All API Return { status: 1, response: ... } or { status: 0, error: ... }
JWT Tokens are set to expire in 2 hours time

POST /users/register

Request

{
    username: String,
    password: String,
    role: ["teacher"|"student"]
}

Returns
- Header: { Authorization: "Bearer <JWT Token>" }

POST /users/authenticate

Request

{
    username: String,
    password: String
}

Returns
- Header: { Authorization: "Bearer <JWT Token>" }

GET /users/current

Request
- Header: { Authorization }

Returns

{
    id: String (user_id),
    username: String,
    role: ["teacher"|"student"]
}

GET /users/delete

Request
- Header: { Authorization }
Returns None

GET /sessions

gets all online sessions
Request None

Returns

{
    sessions: [
        {
            session_id: int (session_id),
            session_name: String,
            opener: String (user_id),
            lobby_size: int
        }
    ]
}

POST /sessions/new

creates a new session and names it <username>'s Session or, if passed a name in rbody, whatever that name is

Request

{
    session_name: String (optional)
}

Header: { Authorization }

Returns

{
    created: {
        session_id: int (session_id),
        session_name: String
    }
}

GET /sessions/enter

enters a session, placing the user in the session's lobby and allowing them to run many of the below endpoints
Request
```
{
    session_id: int (session_id)
}
```
- Header: { Authorization }
Returns None

GET /sessions/leave

leaves a session, removing the user from the session's lobby and denying them access to many of the below endpoints
Request
```
{
    session_id: int (session_id)
}
```
- Header: { Authorization }
Returns None

GET /sessions/delete

only possible for session creator
Request { session_id: int (session_id) }
- Header: { Authorization }
Returns None

GET /sessions/get

a more in-depth look at a sessions, requires user in session
Request
```
{
    session_id: int (session_id)
}
```
- Header: { Authorization }

Returns

{
    session_id: int (session_id),
    session_name: String,
    opener: String (user_id),
    doubts: [
        {
            question: String,
            comments: [
                {
                    comment: String,
                    commenter: String (user_id),
                    comment_id: int (comment_id)
                }
            ],
            poster: String (user_id),
            doubt_id: int (doubt_id),
            upvoters: [String (user_id)],
            downvoters: [String (user_id)]
        }
    ],
    current_users: [String (user_id)]  // number of people in lobby
}

POST /doubt/new

posts a doubt, requires user in session

Request

{
    session_id: int (session_id),
    question: String
}

Header: { Authorization }

Returns None

GET /doubt/vote

votes on a doubt, requires user in session

Request

{
    session_id: int (session_id),
    doubt_id: int (doubt_id),
    type: ["upvote"|"downvote"|"neutral"]
}

Header: { Authorization }

Returns something like "Upvoted", "Downvoted", "Neutralized", "Already upvoted, did nothing", etc...

GET /doubt/resolve

resolves a doubt, requires user in session AND doubt posted by user

Request

{
    session_id: int (session_id),
    doubt_id: int (doubt_id)
}

Header: { Authorization }

Returns None

POST /doubt/comment

comments on a doubt, requires user in session

Request

{
    session_id: int (session_id),
    doubt_id: int (doubt_id),
    comment: String
}

Header: { Authorization }

Returns None

GET /doubt/comment/remove

removes comment on a doubt, requires user in session AND comment posted by user or doubt posted by user

Request

{
    session_id: int (session_id),
    doubt_id: int (doubt_id),
    comment_id: int (comment_id)
}

Header: { Authorization }

Returns None

Website Functionality

The website is built in django. You can access it here

The website will run when you run the manage.py using the command "python manage.py runserver" in the command prompt when you're in the directory of the file.

the website will be functional at localhost:8000

If you need help starting it, feel free to contact me or visit Django