localhost-server / MCQ-Generator

An app to Generate MCQ questions.

MCQ-Generator

Generate MCQ questions using GPT4 or other models

Table of Contents

• Introduction
• Prerequisites
• Installation
  • Download
  • Installation Steps
• Usage
• Configuration
• Contributing
• License

Introduction

You just need an API key from OpenAI to use this app and your docs file containing questions in a specific format . Samples of docs file have been given into testdocs folder.

Prerequisites

Before you begin, make sure you have the following prerequisites installed:

• Python 3.8+
• Linux / Windows

Installation

Download

Download the latest release from Release Page.

Installation Steps

Make sure to install Miniconda , Git and Pandoc included in the same folder.

1. Step 1: Clone the repository

   git clone https://github.com/localhost-server/MCQ-Generator.git

2. Step 2: Install dependencies

   cd MCQ-Generator
   pip install -r requirements.txt

Usage

1. On Windows run start.bat in terminal or double click over it.

   ./start.bat

2. On Linux run start.sh in terminal after you made it executable

   chmod +x start.sh
   ./start.sh

License

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