admin/38894-vm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Resolved README merge conflict

Browse Source
This commit is contained in:
ibm nz 2026-03-01 02:17:57 +05:00
commit 647de236a5
2 changed files with 43 additions and 273 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

140
.gitignore vendored
View File

@ -1,141 +1,41 @@
# Do not upload folder, auto created at each run # Custom
pdf/ pdf/
# Byte-compiled / optimized / DLL files # Python
__pycache__/ __pycache__/
*.py[cod] *.py[cod]
*$py.class *$py.class
# C extensions
*.so *.so
# Distribution / packaging # Distribution
.Python
build/ build/
develop-eggs/
dist/ dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/ *.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller # Environment
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env .env
.envrc
.venv .venv
env/ env/
venv/ venv/
ENV/ ENV/
env.bak/
venv.bak/
# Spyder project settings # Flask
.spyderproject instance/
.spyproject .webassets-cache
# Rope project settings # Database
.ropeproject db.sqlite3
db.sqlite3-journal
# mkdocs documentation # Coverage
/site .coverage
.coverage.*
htmlcov/
# mypy # IDE
.mypy_cache/ .vscode/
.dmypy.json .idea/
dmypy.json
# Pyre type checker # OS
.pyre/ .DS_Store
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/

176
README.md
View File

@ -1,158 +1,28 @@
# MLH Quizzet # hikaruven
# Focus Unlock
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. AI-powered learning platform that helps you study smarter.
[![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 ## Features
- Paste any study text → generates 5 multiple-choice questions using OpenAI
- Interactive quiz with instant feedback and scoring
- Save past quiz results (score, date, percentage)
- View detailed past quiz answers & correct answers
- Save and manage study materials locally
- Responsive Bootstrap 5 design + modern indigo theme
- implements automatic question generation _(AQG) techniques_ ## Tech stack
> **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)) - Backend: Flask (Python)
- helps in **resource saving**(time, money and human effort) - AI: OpenAI GPT-4o-mini
- enables the **enrichment of the teaching** process, adapt learning to student knowledge and needs, as well as drill and practice exercises - Frontend: HTML + Bootstrap 5 + JavaScript
- presents an _automatic mechanism_ to assemble exams or to adaptively select questions from a question bank - Storage: browser localStorage (no database yet)
## WorkFlow ## How to run locally
![workflow](https://user-images.githubusercontent.com/42115530/95686207-1111e300-0c1a-11eb-993a-766967b91c92.png) 1. Clone repo
2. `cd focus-unlock`
## Demo Video 3. `python -m venv env`
<a href="https://youtu.be/74RrpcO89E0" target="_blank" rel="noopener"> 4. `source env/bin/activate` (Mac/Linux) or `env\Scripts\activate` (Windows)
<img src="https://user-images.githubusercontent.com/42115530/95742312-6c40e580-0cad-11eb-89a5-c2ee099bf8d7.png" alt="MLH-Quizzet" 5. `pip install flask openai`
title="MLH-Quizzet" width="400px" /> 6. Set your OpenAI key:
</a> ```bash
export OPENAI_API_KEY="sk-..."
## Technology Stack:
<img src="https://img.shields.io/badge/html5%20-%23E34F26.svg?&style=for-the-badge&logo=html5&logoColor=white"/> <img src="https://img.shields.io/badge/css3%20-%231572B6.svg?&style=for-the-badge&logo=css3&logoColor=white"/> <img src="https://img.shields.io/badge/javascript%20-%23323330.svg?&style=for-the-badge&logo=javascript&logoColor=%23F7DF1E"/> <img src="https://img.shields.io/badge/python%20-%2314354C.svg?&style=for-the-badge&logo=python&logoColor=white"/> <img src="https://img.shields.io/badge/flask%20-%23000.svg?&style=for-the-badge&logo=flask&logoColor=white"/> <img src="https://img.shields.io/badge/bootstrap%20-%23563D7C.svg?&style=for-the-badge&logo=bootstrap&logoColor=white"/> <img src="https://img.shields.io/badge/github%20-%23121011.svg?&style=for-the-badge&logo=github&logoColor=white"/> <img src ="https://img.shields.io/badge/sqlite-%2307405e.svg?&style=for-the-badge&logo=sqlite&logoColor=white"/>
- **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) |
<br>
<br>
![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)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody><tr>
<td align="center"><a href="https://www.linkedin.com/in/PragatiVerma18/"><img alt="" src="https://avatars2.githubusercontent.com/u/42115530?v=4" width="100px;"><br><sub><b>Pragati Verma</b></sub></a><br><a href="https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/commits?author=PragatiVerma18" title="Code">💻</a></td>
<td align="center"><a href="https://kshitij86.github.io/"><img alt="" src="https://avatars1.githubusercontent.com/u/26821140?s=460&u=c86d062a10d9d4495dd39c0ad4f8601ba256d670&v=4" width="100px;"><br><sub><b>Kshitij Kotasthane</b></sub></a><br><a href="https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/commits?author=kshitij86" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/telescopic"><img alt="" src="https://avatars1.githubusercontent.com/u/45061877?s=400&u=07ac89db20b5d84eb1abd4a0769b19d030f8ceb8&v=4" width="100px;"><br><sub><b>Vignesh S</b></sub></a><br><a href="https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/commits?author=telescopic" title="Code">💻</a></td>
</tr>
</tbody></table>
<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
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/)
---