https://github.com/alpha951/reelo

Last synced: over 1 year ago
JSON representation

Host: GitHub
URL: https://github.com/alpha951/reelo
Owner: alpha951
Created: 2023-11-25T11:10:08.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-11-26T09:05:30.000Z (over 2 years ago)
Last Synced: 2025-02-01T20:15:50.000Z (over 1 year ago)
Language: JavaScript
Size: 37.1 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Quiz App API

This is a simple Node.js Express application for a quiz app, providing an API to retrieve questions based on specified criteria.

## Table of Contents

- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [API Endpoint](#api-endpoint)
- [Request Body](#request-body)
- [Questions Service](#questions-service)
- [Error Handling](#error-handling)

## Introduction

This application serves as the backend for a quiz app, allowing users to retrieve questions based on their desired difficulty levels and total marks. The API is designed to be straightforward, with a single endpoint to request questions.

## Installation

1. Clone the repository:

```bash
git clone https://github.com/alpha951/reelo
```

2. Navigate to the project directory:

```bash
cd reelo
```

3. Install dependencies:

```bash
npm install
```

4. Start the application:

```bash
node index.js
```

## Usage

The application provides a RESTful API to fetch questions for a quiz. Refer to the [API Endpoint](#api-endpoint) and [Request Body](#request-body) sections for details on making requests.

## API Endpoint

- **Endpoint:** `/v1/questions`
- **Method:** `POST`

## Request Body

The endpoint expects the following JSON structure in the request body:

```json
{
"totalMarks": 100,
"easyPercentage": 30,
"mediumPercentage": 40,
"hardPercentage": 30
}
```

- `totalMarks`: Total marks for the quiz.
- `easyPercentage`: Percentage of easy questions.
- `mediumPercentage`: Percentage of medium questions.
- `hardPercentage`: Percentage of hard questions.

## Questions Service

The core functionality is implemented in the `question.service.js` file. This service handles the loading and selection of questions based on the provided criteria.

### Functions

#### `loadQuestions(filePath: string): Promise`

Loads questions from the specified JSON file.

#### `getQuestions(data: object): Promise`

Selects questions based on the provided criteria (total marks and difficulty percentages).

### Usage

#### Example - 1

req.body

````json
{
"totalMarks": 100,
"easyPercentage": 20,
"mediumPercentage": 50,
"hardPercentage": 30
}
````
response

```json
{
"success": true,
"message": "Successfully completed the request",
"data": {
"easy": [
{
"id": 1,
"question": "What is the speed of light",
"subject": "Physics",
"topic": "Motion",
"difficulty": "Easy",
"marks": 5
},
{
"id": 3,
"question": "If an object is moving with constant speed, what can you say about its acceleration?",
"subject": "Physics",
"topic": "Motion",
"difficulty": "Easy",
"marks": 5
},
{
"id": 6,
"question": "What is the molecular structure of water?",
"subject": "Chemistry",
"topic": "Chemical Bonding",
"difficulty": "Easy",
"marks": 5
},
{
"id": 10,
"question": "What are isotopes in the context of atomic structure?",
"subject": "Chemistry",
"topic": "Atomic Structure",
"difficulty": "Easy",
"marks": 5
}
],
"medium": [
{
"id": 2,
"question": "State the first law of thermodynamics.",
"subject": "Physics",
"topic": "Thermodynamics",
"difficulty": "Medium",
"marks": 10
},
{
"id": 4,
"question": "Solve the quadratic equation: (2x^2 - 5x + 2 = 0).",
"subject": "Mathematics",
"topic": "Quadratic Equations",
"difficulty": "Medium",
"marks": 10
},
{
"id": 7,
"question": "Balance the following chemical equation: (C_4H_{10} + O_2 rightarrow CO_2 + H_2O).",
"subject": "Chemistry",
"topic": "Chemical Equations",
"difficulty": "Medium",
"marks": 10
},
{
"id": 9,
"question": "Evaluate the integral: (int (3x^2 + 2x - 5) ,dx).",
"subject": "Mathematics",
"topic": "Integration",
"difficulty": "Medium",
"marks": 10
},
{
"id": 12,
"question": "Explain the concept of oxidation and reduction in chemical reactions.",
"subject": "Chemistry",
"topic": "Redox Reactions",
"difficulty": "Medium",
"marks": 10
}
],
"hard": [
{
"id": 5,
"question": "Define the concept of limit in calculus.",
"subject": "Mathematics",
"topic": "Calculus",
"difficulty": "Hard",
"marks": 15
},
{
"id": 8,
"question": "Explain the concept of wave-particle duality in quantum mechanics.",
"subject": "Physics",
"topic": "Quantum Mechanics",
"difficulty": "Hard",
"marks": 15
}
]
},
"error": {}
}
```

#### Example - 2

req.body

````json
{
"totalMarks": 20,
"easyPercentage": 100,
"mediumPercentage": 0,
"hardPercentage": 0
}
````

response

```

## Error Handling

The application uses the `AppError` class for error handling. Specific error messages and HTTP status codes are provided for different scenarios, ensuring clear communication with the client.

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/alpha951/reelo

Awesome Lists containing this project

README