38894-vm/README.md
azurfakh 9073af119e
Revise README for Focus Unlock project details
Updated project name and added features, tech stack, and local run instructions.
2026-03-01 01:40:35 +05:00

29 lines
848 B
Markdown

# hikaruven
# Focus Unlock
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
## Tech stack
- Backend: Flask (Python)
- AI: OpenAI GPT-4o-mini
- Frontend: HTML + Bootstrap 5 + JavaScript
- Storage: browser localStorage (no database yet)
## 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-..."