jonatanpedersen / buzztastic

The Buzztastic Quiz Buzzer

buzztastic

Qubu - The Buzztastic Quiz Buzzer

Install

npm install

Build

npm run build

Runs tsc and webpack.

Start

npm start

Runs node.

Develop

npm run develop

Runs nodemon, and tsc and webpack in watch modes. Listens on localhost port 1432.

Debug

export DEBUG=qubu
export DEBUG_COLORS=1

Test

npm test

Runs mocha.

API

Create Quiz POST /api/quizzes

Request Body:

{
    "name": "Bananas"
}

Response Body:

{
    "quizId": "b0ad66ee-6001-4be8-8a88-9e03dda3c699"
}

Get Quiz GET /api/quizzes/:quizIdOrCode

Response Body:

{
    "quizId": "b0ad66ee-6001-4be8-8a88-9e03dda3c699",
    "code": "NJOIPN",
    "name": "H4ck th3 pl4n3t",
    "players": [
        {
            "playerId": "b2100f76-3ff2-4225-822a-bf118b9937d3",
            "name": "Super Coder",
            "teamId": "d363e891-f531-4157-ac89-9122309d1bbd",
            "created": "2018-03-16T14:54:08.577Z"
        }
    ],
    "teams": [
        {
            "teamId": "d363e891-f531-4157-ac89-9122309d1bbd",
            "name": "Team Awesome",
            "created": "2018-03-16T14:54:08.577Z"
        }
    ],
    "rounds": [
        {
            "roundId": "4e74a3ac-92b0-456a-b4a8-b790e2974f44",
            "created": "2018-03-16T16:35:45.858Z",
            "buzzes": [
                {
                    "buzzId": "1fa1245e-f994-4ac1-b201-d47ac4e08f4f",
                    "playerId": "b2100f76-3ff2-4225-822a-bf118b9937d3",
                    "teamId": "d363e891-f531-4157-ac89-9122309d1bbd",
                    "created": "2018-03-16T17:19:01.470Z"
                }
            ]
        }
    ],
    "currentRoundId": "4e74a3ac-92b0-456a-b4a8-b790e2974f44",
    "created": "2018-03-14T17:19:01.470Z"
}

Create Quiz Team POST /api/quizzes/:quizIdOrCode/teams

Request Body:

{
    "name": "Team Awesome"
}

Response Body:

{
    "quizId": "b0ad66ee-6001-4be8-8a88-9e03dda3c699",
    "teamId": "d363e891-f531-4157-ac89-9122309d1bbd"
}

Create Quiz Player POST /api/quizzes/:quizIdOrCode/players

Request Body:

{
    "name": "Super Coder"
}

Response Body:

{
    "quizId": "b0ad66ee-6001-4be8-8a88-9e03dda3c699",
    "playerId": "b2100f76-3ff2-4225-822a-bf118b9937d3"
}

Update Quiz Player PUT /api/quizzes/:quizIdOrCode/players/:playerId

Request Body:

{
    "name": "Really Super Coder",
    "teamId": "d363e891-f531-4157-ac89-9122309d1bbd"
}

Response Body:

{
    "quizId": "b0ad66ee-6001-4be8-8a88-9e03dda3c699",
    "playerId": "b2100f76-3ff2-4225-822a-bf118b9937d3"
}

Delete Quiz Player DELETE /api/quizzes/:quizIdOrCode/players/:playerId

Create Quiz Round POST /api/quizzes/:quizIdOrCode/rounds

Creates a new round and sets currentRouteId to the new rounds Id.

Response Body:

{
    "quizId": "b0ad66ee-6001-4be8-8a88-9e03dda3c699",
    "roundId": "4e74a3ac-92b0-456a-b4a8-b790e2974f44"
}

Create Quiz Round Buzz POST /api/quizzes/:quizIdOrCode/rounds/current/buzzes

Request Body:

{
    "playerId": "b2100f76-3ff2-4225-822a-bf118b9937d3",
    "teamId": "d363e891-f531-4157-ac89-9122309d1bbd"
}

Response Body:

{
    "quizId": "b0ad66ee-6001-4be8-8a88-9e03dda3c699",
    "roundId": "4e74a3ac-92b0-456a-b4a8-b790e2974f44",
    "buzzId": "1fa1245e-f994-4ac1-b201-d47ac4e08f4f"
}