Online Quiz Application using Nest.js and MongoDB

Nest is a prograssive Node.js framework with TypeScript for building efficient and scalable server-side/backend applications.

Description

Online quiz application backend with Node.js framework. available features are user login, user register, quiz addition, question addition.

Technologies Used

Node.js, NestJs
Typescript
PassportJs with Jwt
MongoDB
Mongoose
Rest client
git

Application Entities

Users (Quiz Setter/Taker)
Quiz
Question -> Options

Folder structure

- src
    - auth # User authentication and JWT implementation features
    - users # User Entity implementation
        - dto # Data Transfer Object
        - schemas # Entity schema
    - quizTest # Quiz Entity implementation
        - dto
        - schemas
    - quizQuestions # Quiz Question Entity implementation
        - dto 
        - schemas
- example-questions.json # question examples in json format
- example-quizes.json # quiz examples in json format
- rest-client-test.http  # api request test example

Installation

$ npm install -g @nestjs/cli
$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Rest-API End Examples

1 - register a new user

POST http://localhost:3000/users/registerUser
Content-Type: application/json

{ 
    "username": "test2",
    "fullName": "Test User 2",
    "email": "test2@mail.com",
    "password": "pass123"
}

2 - login -> response will be a jwt token for api authorization

POST http://localhost:3000/auth/login
Content-Type: application/json

{
    "username": "test2", 
    "password": "pass123"
}

3 - get all available quizes

GET  http://localhost:3000/quiz-test/availableQuizes
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9....

4 - user requests for taking a quiz -> in response get a quiz with unique request id

POST http://localhost:3000/users/requestQuiz
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....
{
    "username": "test2",
    "quizId": "quiz03"
}

5 - user submits quiz answer with unique request id and quiz score

POST http://localhost:3000/users/submitQuiz
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9....

{
    "username": "test2",
    "quizId": "quiz03",
    "requestId": "c5661978-eb8e-47ff-bbc0-611aa411a64d",
    "score": 30
}

6 - Add new QuizTest (Example Quizes in Json Format)

POST http://localhost:3000/quiz-test/newQuizTest
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9....

{
    "quizId": "quiz04",
    "quizName": "Quiz-04",
    "quizDescription": "This is Quiz-04",
    "numberOfQuestions": 7,
    "quizDuration": 18,
    "quizStatus": "active",
    "quizIsOpen": false
}

7 - update/patch a quiz info according to quiz schema

PATCH http://localhost:3000/quiz-test/updateQuiz
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9....

{
    "quizId": "quiz04",
    "quizIsOpen": true
}

8 - add a new quiz question (Example Questions in Json Format)

POST http://localhost:3000/quiz-questions/newQuestion
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9....

{
        "questionId": "q10",
        "questionName": "Development Knowledge",
        "questionDescription": "What is correct MIME type for JSON ?",
        "answerOptions": [
            {
                "optionId": 1,
                "optionDescription": "json/mime",
                "isCorrect": false
            },
            {
                "optionId": 2,
                "optionDescription": "application/js",
                "isCorrect": false
            },
            {
                "optionId": 3,
                "optionDescription": "application/xml",
                "isCorrect": false
            },
            {
                "optionId": 4,
                "optionDescription": "none of these",
                "isCorrect": true
            }
        ],
        "correctAnswer": 4,
        "isPublished": true
    }

9 - get all available quiz questions (only questions)

GET  http://localhost:3000/quiz-questions/questions
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9....

10 - update/patch a quiz question with question id

PATCH http://localhost:3000/quiz-questions/updateQuestion
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9....

{
    "questionId": "q1",
    "questionName": "Meaning of life"
}

absjabed / nestjs-online-quiz