Quizandlearn backend

December 19, 2022 · View on GitHub

Quizandlearn is a collaborative quizzes plateform based on NodeJs and React.js.

Prerequisites

Quizandlearn requires node 16.9.1 with npm 7.21.1*

Installation

Clone the repository
Add a new .env file.

MONGODB_URI= "mongodb+srv:// login / credentials "
FRONTEND_URL="http://localhost:3000"
BACKEND_URL="http://localhost:4000"}

Install dependencies

$ npm install

Run server

$ npm start
$ nodemon server

Testing

To run tests

$ npm test

Linter

Quizandlearn follows the Airbnb style guide. To help us we use ESLint as a linter:

$ npm lint

To automatically fix what can be:

npm run lint -- --fix

Example: http://example.gov/api/auth/signup

Request body:

{
    "name": "Jane",
    "surname": "lala",
    "email": "user@gmail.com",
    "password": "Motdepass123!"
}

Response body:

{
    "message": "Utilisateur créé !"
}

Example: http://example.gov/api/auth/login

Response body:

{
    "userId": "78928dfd74013bf4d5097789",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpFGRfr.eyJ1c2VySWQiOiI2MjgyOGRmZDc0MDEzYmY0ZDUwOTc0ZDMiLCJpYXQiOjE2NTI3MjMyODYsImV4cCI6MTY1MjgwOTY4Nn0.FnKqrM30L_l7TjWngLV5Xa-ZIKZ0UFjdB2bBpjAo_9k"
}

GET /quizzes

Example: http://example.gov/api/quizzes

Response body:

{
      "quizzes": [
        {
          "_id": "ObjectId",
          "id_user_owner": "ObjectId",
          "title": "Quiz title",
          "description": "Quiz description",
          "categories": [
            "category"
          ],
          "questions": [...],
          "reportings": [],
          "ratings": [],
          "createdAt": "2022-09-09T14:09:38.963Z",
          "updatedAt": "2022-09-09T14:09:38.963Z",
          "__v": 0
      }
    ]
}

POST /quizzes

Example: http://example.gov/api/quizzes

Request body:

{
    "id_user_owner": "ObjectId",
    "name_user_owner": { type: String, required: true }
    "surname_user_owner": { type: String, required: true }
    "title": "Quiz title",
    "description": "Quiz description",
    "categories": [
        "category"
    ],
    "questions": [
        {
            "title": "First question title",
            "choices": [
                {
                    "content": "wrong answer",
                    "isCorrect": false
                },
                {
                    "content": "good answer",
                    "isCorrect": true
                }
            ],
            "explanation": "First question answer explanation",
            "link_to_learn_more": "url"
        },
         {
            "title": "Second question title",
            "choices": [
                {
                    "content": "wrong answer",
                    "isCorrect": false
                },
                {
                    "content": "good answer",
                    "isCorrect": true
                }
            ],
            "explanation": "Second question answer explanation",
            "link_to_learn_more": "url"
         },
        {
            "title": "Third question title",
            "choices": [
                {
                    "content": "good answer",
                    "isCorrect": true
                },
                {
                    "content": "wrong answer",
                    "isCorrect": false
                }
            ],
            "explanation": "Third question answer explanation",
             "link_to_learn_more": "url"
        }
    ]
}

Response body:

{
    "message": "Quiz créé",
    "idQuiz": "62e92ffr70f06db885f3hgtf"
}

GET /categories

Example: http://example.gov/api/categories

Response body:

{
    "categories": [
        {
            "_id": "623dd2b5933112fee687ee44",
            "title": "Tech"
        },
        {
            "_id": "623dd301933112feefr7ee45",
            "title": "Feminism"
        },
        {
            "_id": "627527dfr52c45e662afd317",
            "title": "Other"
        }
    ]
}

Deployment

Quizandlearn is deployed automatically on pull request on a heroku server at https://quiz-and-learn-heroku-front.herokuapp.com/