Resolved README merge conflict
This commit is contained in:
ibm nz
commit
647de236a5
140
.gitignore
vendored
140
.gitignore
vendored
@ -1,141 +1,41 @@
|
||||
# Do not upload folder, auto created at each run
|
||||
# Custom
|
||||
pdf/
|
||||
|
||||
# Byte-compiled / optimized / DLL files
|
||||
# Python
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
# Distribution
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
wheels/
|
||||
share/python-wheels/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
MANIFEST
|
||||
|
||||
# PyInstaller
|
||||
# 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
|
||||
# Environment
|
||||
.env
|
||||
.envrc
|
||||
.venv
|
||||
env/
|
||||
venv/
|
||||
ENV/
|
||||
env.bak/
|
||||
venv.bak/
|
||||
|
||||
# Spyder project settings
|
||||
.spyderproject
|
||||
.spyproject
|
||||
# Flask
|
||||
instance/
|
||||
.webassets-cache
|
||||
|
||||
# Rope project settings
|
||||
.ropeproject
|
||||
# Database
|
||||
db.sqlite3
|
||||
db.sqlite3-journal
|
||||
|
||||
# mkdocs documentation
|
||||
/site
|
||||
# Coverage
|
||||
.coverage
|
||||
.coverage.*
|
||||
htmlcov/
|
||||
|
||||
# mypy
|
||||
.mypy_cache/
|
||||
.dmypy.json
|
||||
dmypy.json
|
||||
# IDE
|
||||
.vscode/
|
||||
.idea/
|
||||
|
||||
# Pyre type checker
|
||||
.pyre/
|
||||
|
||||
# pytype static type analyzer
|
||||
.pytype/
|
||||
|
||||
# Cython debug symbols
|
||||
cython_debug/
|
||||
# OS
|
||||
.DS_Store
|
||||
|
||||
176
README.md
176
README.md
@ -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.
|
||||
|
||||
[](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/network/members)
|
||||
[](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/stargazers)
|
||||
[](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/watchers)
|
||||
[](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/pulls)
|
||||
[](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/issues)
|
||||
[](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/blob/master/LICENSE)
|
||||
[](https://GitHub.com/PragatiVerma18/Fantastic-Falcons-1.0/graphs/commit-activity)
|
||||
[](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/)
|
||||
AI-powered learning platform that helps you study smarter.
|
||||
|
||||
## 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_
|
||||
> **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
|
||||
## Tech stack
|
||||
- Backend: Flask (Python)
|
||||
- AI: OpenAI GPT-4o-mini
|
||||
- Frontend: HTML + Bootstrap 5 + JavaScript
|
||||
- Storage: browser localStorage (no database yet)
|
||||
|
||||
## WorkFlow
|
||||
|
||||
|
||||
## Demo Video
|
||||
<a href="https://youtu.be/74RrpcO89E0" target="_blank" rel="noopener">
|
||||
<img src="https://user-images.githubusercontent.com/42115530/95742312-6c40e580-0cad-11eb-89a5-c2ee099bf8d7.png" alt="MLH-Quizzet"
|
||||
title="MLH-Quizzet" width="400px" />
|
||||
</a>
|
||||
|
||||
## 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?
|
||||
|
||||
[](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/blob/webapp/requirements.txt)
|
||||
[](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
|
||||
|
||||
[](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>
|
||||
|
||||
|
||||
|
||||
## 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!
|
||||
|
||||
[](https://github.com/)
|
||||
[](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/)
|
||||
[](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/)
|
||||
[](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/)
|
||||
|
||||
[](https://www.python.org/)
|
||||
[](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/)
|
||||
[](https://github.com/PragatiVerma18/Fantastic-Falcons-1.0/)
|
||||
|
||||
---
|
||||
## How to run locally
|
||||
1. Clone repo
|
||||
2. `cd focus-unlock`
|
||||
3. `python -m venv env`
|
||||
4. `source env/bin/activate` (Mac/Linux) or `env\Scripts\activate` (Windows)
|
||||
5. `pip install flask openai`
|
||||
6. Set your OpenAI key:
|
||||
```bash
|
||||
export OPENAI_API_KEY="sk-..."
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user