Q-gen

Generate quizes from pdfs

Q-gen is an app, that generates "fill in the black" type questions from the text-paragraphs entered by the user or the pdfs uploaded.

The product can be used both by teachers as well as students.

For Students :

• Study from your materials and then up upload them into the app to generate questions. Answer the questions and get your score to evaluate yourself.
• Or simply, avoid the hassle of studying from boring pdfs and let the app generate smart question & answers for you, boost your efficiency.

For Teachers :

• Want to avoid the hectic job of framing questions and answers for upcoming tests ?
• Sit back and let Q-Gen do the hard work for you. The app generates questions & answers from the materials provided, all you have to do is review and publish them into the question paper.

Platforms

• Q-gen Website which can be accessed via any web browser

Tools Used

• Visual Studio Code
• Google Chrome Browser

Overview

Webapp

Prerequisites

• python 3.7 or above
• node.js installed

Installation

For running the backend server

flask server in local machine

• cd api

• install pipenv

• pipenv shell

  before shell download python 3.7 or set the python version in pipfile

• pipenv install

• flask run

  OR

• cd api

• pip install -r requirements.txt

• flask run

the server will run on localhost port 5000

The API endpoints for the live backend

the flask server is live

• https://localhost:5000/filetotext

  • POST
  • it recieves file as req ex:-{"file":<---files--->}
  • response extracted text in json ex:-{"data":"extracted text","success":"true"}

• https://localhost:5000/filetoquestion

  • POST
  • it recieves file as req ex:-{"file":<---files--->}
  • response question and ans json ex:-{"answers":"answer","question":"question"}

• https://localhost:5000/texttoquestion

  • POST
  • it recieves text as req ex:-{"key":"any text to be converted to question"}
  • response question and ans json ex:-{"answers":"answer","question":"question"}

For running the react frontend

React development server in local machine

• cd client
• npm install
• npm start

the server will run on localhost port 3000

Use Concurrently for running React in Front-end and Node in Back-end. Runs the app in the development mode.

Open http://localhost:3000 to view Front-end in the browser.
Open http://localhost:5000 to view Back-end in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.