Quizzat

Quizzat is a simple quiz app that allows you to create and play quizzes.

Technologies

Testing and linting

Dev Dependencies

• Node.js
• MongoDB
• Express
• React
• Jest
• ESLint

Frontend Setup

1. Clone the repository.
2. Navigate to the frontend directory.
3. Install the dependencies: yarn install.
4. Start the development server: yarn start.
5. Open your browser and navigate to http://localhost:3000.

Backend Setup

1. Clone the repository.
2. Navigate to the backend directory.
3. Install the dependencies: yarn install.
4. Start the development server: yarn start.
5. Backedn server will be running on http://localhost:4000.

Contribution Guide

1. Fork the repository. // skip if you are a collaborator.
2. Clone the forked repository. // skip if you are a collaborator.
3. Create a new branch with you name as follows: git switch -c <your-name>-dev.
4. Make your changes.
5. Commit your changes: git commit -m "feat: add new feature".
6. Push your changes: git push origin <your-name>-dev.
7. Create a pull request.

API Endpoints

Quizzes

• GET /api/v1/quizzes - Get all quizzes.
• GET /api/v1/quizzes/:id - Get a quiz by id.
• POST /api/v1/quizzes - Create a new quiz.

Questions

• POST /api/v1/quizzes/:quizId/questions - Create a new question for a quiz.

Answers

• POST /api/v1/quizzes/:quizId/questions/:questionId/answers - Create a new answer for a question.

Users

• GET /api/v1/users - Get all users.
• GET /api/v1/users/:id - Get a user by id.
• POST /api/v1/users - Create a new user.

Responses:

• GET /api/v1/quizzes/:id:

[
    {
        "id": "1", // not null, unique
        "name": "Quiz 1", // not null
        "description": "This is a quiz",
        "thumbnail": "https://example.com/image.jpg",
        "tags": ["tag1", "tag2"],
        "level": "easy", // default: "easy", enum: ["easy", "medium", "hard"]
        "createdBy": { "userId": "1" }, // not null
        "createdAt": "2021-10-10T10:00:00.000Z", // not null
        "started": 20, // default: 0
        "finished": 10, // default: 0
        "averageScore": 50,
        "lowestScore": 10,
        "highestScore": 100,
        "topThreeScores": [
            {
                "userId": "1",
                "score": 100
            }
        ],
        "topTenScores": [
            {
                "userId": "1",
                "score": 100
            }
        ],
        "leaderBoard": [
            {
                "userId": "1",
                "score": 100
            }
        ],
        "stared_by": ["1", "2"],
        "questions": [
            {
                "id": "1", // not null, unique
                "content": "Question 1", // not null
                "type": "multiple-choice", // default: "multiple-choice", enum: ["single-choice", "multiple-choice", "true-false"]
                "answers": [
                    {
                        "id": "1", // not null, unique
                        "content": "Answer 1", // not null
                        "correct": true
                    },
                    {
                        "id": "2",
                        "title": "Answer 2",
                        "correct": false
                    }
                ]
            }
        ]
    }
]

TODO List

• Create a quiz with multiple questions and answers.
• Play a quiz.
• View the results of a quiz.
• User authentication.
• User status and/or profile.
• Leaderboard.
• Share quizzes.
• Search for quizzes.
• Tags for quizzes.

Authors

developers:

• SaiAI
• mubarak

designers:

• Ali