https://github.com/hirentimbadiya/question_paper_generator

Question Paper Generator API
https://github.com/hirentimbadiya/question_paper_generator

docker docker-compose express mongodb mongoose nodejs swagger

Last synced: about 21 hours ago
JSON representation

Question Paper Generator API

• Host: GitHub
• URL: https://github.com/hirentimbadiya/question_paper_generator
• Owner: hirentimbadiya
• License: mit
• Created: 2023-11-22T17:31:15.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-04-08T11:41:53.000Z (8 months ago)
• Last Synced: 2024-05-02T06:00:11.261Z (7 months ago)
• Topics: docker, docker-compose, express, mongodb, mongoose, nodejs, swagger
• Language: JavaScript
• Homepage: https://question-paper-generator-rx2z.onrender.com/api-docs/
• Size: 49.8 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Question Paper Generator

This is a Node.js application which generates question paper according to total marks and difficulty distribution from easy, medium and hard questions. The questions are fetched from the database and are shuffled before generating the question paper.

## Deployment

**you can find swagger documentation here -> [question-paper-generator](https://question-paper-generator-rx2z.onrender.com/api-docs/)**

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

What things you need to install the software and how to install them:

- **All you need to run this app locally is docker. You can download it from [here](https://www.docker.com/products/docker-desktop)**.

- **`Docker and Docker Desktop`**

- if you want to run this app **without docker** then you need to install following things:

  - **`Node.js`**

  - **`MongoDB`**

### Installing

A step by step series of examples that tell you how to get a development environment running:

1. **Clone the repository**

    ```bash

    git clone https://github.com/hirentimbadiya/question_paper_generator.git

    ```

2. **Set up the environment variables in .env file**

3. **Start Docker Desktop**

4. **go to root directory** of the project ***i.e. question_paper_generator***

5. **Run `docker-compose up` to start the server.**

6. **if you are not using docker then install the dependencies using `npm install` command and then start the local development server using `node app.js` or `npm run dev` command.**

7. **then you need to also start mongoDB in your local environment.**

8. **change url in swagger.js file to `http://localhost:3000` if you are running the server locally.**

9. **Go to `http://localhost:3000/api-docs` to view the Swagger documentation.**

## File Structure

- **`app.js`**: The main application file.

- **`routes/questionRouter.js`**: Handles question-related routes.

- **`controllers/questionController.js`**: Handles question-related logic.

- **`controllers/getQuestionsController.js`**: Handles logic for getting questions from the database.

- **`models/questionModel.js`**: Defines the question schema.

- **`swagger.js`**: Sets up Swagger documentation.

- **`docker-compose.yml`**: Sets up the docker containers.

- **`Dockerfile`**: Sets up the docker image.

## Built With

- [Node.js](https://nodejs.org/en/) - Backend runtime

- [Express.js](https://expressjs.com/) - The web framework used

- [MongoDB](https://www.mongodb.com/) - Database Management

- [Swagger](https://swagger.io/) - API Documentation

## Authors

- [**hirentimbadiya**](https://github.com/hirentimbadiya)

- **Email** : **[email protected]**

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details