From 0006c5ec4a403724fe695dbc2125ba9eb0db9e9e Mon Sep 17 00:00:00 2001 From: PragatiVerma18 Date: Sat, 10 Oct 2020 12:51:53 +0530 Subject: [PATCH] Feat Documentation - Updated Readme --- README.md | 150 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 149 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 71d5356..a92a6c8 100644 --- a/README.md +++ b/README.md @@ -1 +1,149 @@ -# Fantastic-Falcons-1.0 \ No newline at end of file +# Fantastic-Falcons-1.0 + +This is a smart Quiz Generator that generates a dynamic quiz from any uploaded text/PDF document using NLP. This can be used for self-analysis, question paper generation, and evaluation, thus reducing human effort. + +[![Forks](https://img.shields.io/github/forks/PragatiVerma18/Fantastic-Falcons-1.0?style=social)](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/network/members) +[![Stars](https://img.shields.io/github/stars/PragatiVerma18/Fantastic-Falcons-1.0?style=social)](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/stargazers) +[![Watchers](https://img.shields.io/github/watchers/PragatiVerma18/Fantastic-Falcons-1.0?style=social)](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/watchers) +[![PRs](https://img.shields.io/github/issues-pr/PragatiVerma18/Fantastic-Falcons-1.0)](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/pulls) +[![Issues](https://img.shields.io/github/issues/PragatiVerma18/Fantastic-Falcons-1.0)](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/issues) +[![License](https://img.shields.io/github/license/PragatiVerma18/Fantastic-Falcons-1.0)](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/blob/master/LICENSE) +[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/PragatiVerma18/Fantastic-Falcons-1.0/graphs/commit-activity) +[![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/) + +## Features + +- implements automatic question generation _(AQG) techniques_ + > **Automatic question generation (AQG)** is concerned with the construction of algorithms for producing questions from knowledge sources, which can be either structured (e.g. knowledge bases (KBs) or unstructured (e.g. text)) +- helps in **resource saving**(time, money and human effort) +- enables the **enrichment of the teaching** process, adapt learning to student knowledge and needs, as well as drill and practice exercises +- presents an _automatic mechanism_ to assemble exams or to adaptively select questions from a question bank + +## Technology Stack: + + + + + + + + + + +- **Frontend**: HTML, CSS, Vanilla JS +- **Backend**: Flask +- **IDE**: VS Code +- **Design**: Canva +- **Version Control**: Git and GitHub +- **Database**: Sqllite3 + +## How to Get Started? + +[![Requirements Up To Date](https://img.shields.io/badge/requirements-up%20to%20date-brightgreen)](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/blob/webapp/requirements.txt) +[![Python](https://img.shields.io/badge/python-v3.7-blue)](https://www.python.org/) + +### GitHub Repository Structure + +| S.No. | Branch Name | Purpose | +| ----- | ----------------------------------------------------------------------------- | ---------------------------------- | +| 1. | [master](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/tree/master) | contains the main code | +| 2. | [nlp](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/tree/nlp) | contains all machine learning code | +| 3. | [webapp](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/tree/webapp) | contains all frontend/backend code | + +### Setup + +- Fork and Clone the repo using + +``` +$ git clone https://github.com/PragatiVerma18/Fantastic-Falcons-1.0.git +$ cd Fantastic-Falcons-1.0 +``` + +- Change Branch to `webapp` using + +``` +$ git checkout webapp +``` + +- Setup Virtual environment + +``` +$ python3 -m venv env +``` + +- Activate the virtual environment + +``` +$ source env/bin/activate +``` + +- Install dependencies using + +``` +$ pip install -r requirements.txt +``` + +- Run Flask server using + +``` +$ python app.py +``` + +## Browser Support + +- **Firefox**: version 4 and up +- **Chrome**: any version +- **Safari**: version 5.2 and up +- **Internet Explorer/Edge**: version 8 and up +- **Opera**: version 9 and up + > **Note**: Support for modern mobile browsers is experimental. The website is not responsive in mobile devices until now. + +## MLH Fellowship( Fall 2020) + +> This is a hackathon project made by MLH Fellows(Fall 2020) - Pod 1.0.0 i.e. Fantastic Falcons + +[![MLH Fellowship](https://challengepost-s3-challengepost.netdna-ssl.com/photos/production/challenge_photos/001/113/145/datas/original.jpg)](https://github.com/MLH-Fellowship) + +## Team: + +> "Alone we can do so little; together we can do so much." + +| S.No. | Name | Role | GitHub Username:octocat: | +| ----- | ------------------ | ------------------ | ---------------------------------------------------- | +| 1. | Pragati Verma | Frontend Developer | [@PragatiVerma18](https://github.com/PragatiVerma18) | +| 2. | Kshitij Kotasthane | Backend Developer | [@kshitij86](https://github.com/kshitij86) | +| 3. | Vignesh S | ML | [@telescopic](https://github.com/telescopic) | + +## Contributors ✨ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + + + +

Pragati Verma
💻
Kshitij Kotasthane
💻
Vignesh S
💻
+ + + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! + +[![ForTheBadge uses-git](http://ForTheBadge.com/images/badges/uses-git.svg)](https://github.com/) +[![ForTheBadge uses-html](http://ForTheBadge.com/images/badges/uses-html.svg)](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/) +[![ForTheBadge uses-css](http://ForTheBadge.com/images/badges/uses-css.svg)](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/) +[![ForTheBadge uses-js](http://ForTheBadge.com/images/badges/uses-js.svg)](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/) + +[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/) +[![ForTheBadge built-by-developers](http://ForTheBadge.com/images/badges/built-by-developers.svg)](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/) +[![ForTheBadge built-with-love](http://ForTheBadge.com/images/badges/built-with-love.svg)](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/) + +---