diff --git a/README.md b/README.md index 71d5356..a3b25cf 100644 --- a/README.md +++ b/README.md @@ -1 +1,147 @@ -# Fantastic-Falcons-1.0 \ No newline at end of file +# MLH Quizzet + +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) | + +
+
+ +![Fantastic Falcons](https://user-images.githubusercontent.com/42115530/95672625-0aef1880-0bc0-11eb-8db6-90f6e16af2c0.gif) + +## 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/) + +--- diff --git a/static/css/quiz.css b/static/css/quiz.css index 82ccb57..e4ef607 100644 --- a/static/css/quiz.css +++ b/static/css/quiz.css @@ -1,3 +1,4 @@ +@import url("https://fonts.googleapis.com/css2?family=Open+Sans&display=swap"); html { box-sizing: border-box; } @@ -10,9 +11,8 @@ html { html, body { - overflow: hidden; position: relative; - height: 100%; + overflow-x: hidden !important; } body { @@ -24,6 +24,7 @@ body { background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='100%25' height='100%25' viewBox='0 0 2 1'%3E%3Cdefs%3E%3ClinearGradient id='a' gradientUnits='userSpaceOnUse' x1='0' x2='0' y1='0' y2='1'%3E%3Cstop offset='0' stop-color='%2377aa77'/%3E%3Cstop offset='1' stop-color='%234fd'/%3E%3C/linearGradient%3E%3ClinearGradient id='b' gradientUnits='userSpaceOnUse' x1='0' y1='0' x2='0' y2='1'%3E%3Cstop offset='0' stop-color='%23cf8' stop-opacity='0'/%3E%3Cstop offset='1' stop-color='%23cf8' stop-opacity='1'/%3E%3C/linearGradient%3E%3ClinearGradient id='c' gradientUnits='userSpaceOnUse' x1='0' y1='0' x2='2' y2='2'%3E%3Cstop offset='0' stop-color='%23cf8' stop-opacity='0'/%3E%3Cstop offset='1' stop-color='%23cf8' stop-opacity='1'/%3E%3C/linearGradient%3E%3C/defs%3E%3Crect x='0' y='0' fill='url(%23a)' width='2' height='1'/%3E%3Cg fill-opacity='0.5'%3E%3Cpolygon fill='url(%23b)' points='0 1 0 0 2 0'/%3E%3Cpolygon fill='url(%23c)' points='2 1 2 0 0 0'/%3E%3C/g%3E%3C/svg%3E"); background-attachment: fixed; background-size: cover; + font-family: "helvetica", sans-serif !important; } a { @@ -33,7 +34,6 @@ a { section { padding-top: 150px; - overflow-y: hidden; } main { @@ -43,9 +43,9 @@ main { color: #000000; background: #ffffff; border-radius: 10px; - padding: 50px 20px 50px; + padding: 50px 40px 50px; width: 95%; - max-width: 500px; + max-width: 590px; margin: auto; } @@ -58,7 +58,7 @@ input[type="radio"] { } input[type="radio"] + label { display: inline-block; - width: 95%; + width: 100%; padding: 10px; border: 1px solid #ddd; margin-bottom: 10px; diff --git a/static/css/style.css b/static/css/style.css index 00a6f11..31dec16 100644 --- a/static/css/style.css +++ b/static/css/style.css @@ -1,3 +1,4 @@ +@import url("https://fonts.googleapis.com/css2?family=Open+Sans&display=swap"); html, body { display: flex; @@ -9,12 +10,14 @@ body { background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='100%25' height='100%25' viewBox='0 0 2 1'%3E%3Cdefs%3E%3ClinearGradient id='a' gradientUnits='userSpaceOnUse' x1='0' x2='0' y1='0' y2='1'%3E%3Cstop offset='0' stop-color='%2377aa77'/%3E%3Cstop offset='1' stop-color='%234fd'/%3E%3C/linearGradient%3E%3ClinearGradient id='b' gradientUnits='userSpaceOnUse' x1='0' y1='0' x2='0' y2='1'%3E%3Cstop offset='0' stop-color='%23cf8' stop-opacity='0'/%3E%3Cstop offset='1' stop-color='%23cf8' stop-opacity='1'/%3E%3C/linearGradient%3E%3ClinearGradient id='c' gradientUnits='userSpaceOnUse' x1='0' y1='0' x2='2' y2='2'%3E%3Cstop offset='0' stop-color='%23cf8' stop-opacity='0'/%3E%3Cstop offset='1' stop-color='%23cf8' stop-opacity='1'/%3E%3C/linearGradient%3E%3C/defs%3E%3Crect x='0' y='0' fill='url(%23a)' width='2' height='1'/%3E%3Cg fill-opacity='0.5'%3E%3Cpolygon fill='url(%23b)' points='0 1 0 0 2 0'/%3E%3Cpolygon fill='url(%23c)' points='2 1 2 0 0 0'/%3E%3C/g%3E%3C/svg%3E"); background-attachment: fixed; background-size: cover; + font-family: "helvetica", sans-serif !important; + overflow-x: hidden !important; } .card { border-radius: 10px; margin-top: 100px !important; - height: 500px !important; - width: 400px; + height: 400px !important; + width: 300px; } .card.has-text-centered .card-header, @@ -50,6 +53,7 @@ body { color: white; font-weight: 400; overflow: hidden; + font-family: "Open Sans", sans-serif !important; } .button:before { position: absolute; diff --git a/static/fonts/helvetica.ttf b/static/fonts/helvetica.ttf new file mode 100644 index 0000000..4d99761 Binary files /dev/null and b/static/fonts/helvetica.ttf differ diff --git a/templates/index.html b/templates/index.html index 10c00a0..7244376 100644 --- a/templates/index.html +++ b/templates/index.html @@ -6,11 +6,19 @@ + MLH Quizzet +