Revise README for Focus Unlock project details
Updated project name and added features, tech stack, and local run instructions.
This commit is contained in:
parent
88130a44d2
commit
9073af119e
28
README.md
28
README.md
@ -1,2 +1,28 @@
|
|||||||
# hikaruven
|
# hikaruven
|
||||||
AI-powered quiz learning platform built with Flask, OpenAI and Bootstrap
|
# 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-..."
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user