📘 LearnNest

AI + Productivity for Students
An intelligent learning and wellness platform that merges adaptive tutoring, productivity tools, spaced repetition flashcards, peer learning, and mental health support — all in one ecosystem.

📑 Table of Contents

1. Key Features
2. Prerequisites
3. Setup Instructions
4. Optional Features
5. Roadmap
6. Contribution
7. Notes

🌟 Key Features:

• Generate validated quizzes from pasted text, your notes, or PDFs/DOCX (PDF built-in, DOCX optional)
• Chunking for large inputs, multilingual output, accessibility phrasing
• RAG optional (Pinecone), Gemini validation, hints, and personalized feedback

🛠️ Prerequisites:

• Node 18+
• Firebase CLI (logged in and set to the right project)
• Firebase project upgraded to Blaze plan for Cloud Functions deploy (Cloud Build/Artifact Registry)

⚡ Setup Instructions

Set required runtime config:

npm install
npm run dev

cd functions
npm install
# Required
firebase functions:config:set openai.key="YOUR_OPENAI_KEY" gemini.key="YOUR_GEMINI_KEY"
# Optional RAG
firebase functions:config:set pinecone.key="YOUR_PINECONE_KEY"

Local build/emulate:

cd functions
npm run build
firebase emulators:start --only functions

Deploy (requires Blaze plan):

cd functions
npm run deploy

📄 Contribution

• Fork the repository
• Create a branch for your feature
• Submit a Pull Request
• Follow proper formatting and test features before submission

📝 Notes

• DOCX parsing via mammoth is optional. To enable:

cd functions && npm i mammoth

• If Pinecone isn’t configured, RAG is skipped gracefully.

6️⃣ Format Roadmap as a table

## 🚀 Roadmap

- [x] MVP: AI Quiz Generator
- [ ] Phase 2: Spaced Repetition Flashcards
- [ ] Phase 3: Productivity Tools (Tasks, Pomodoro, Habit Tracker)
- [ ] Phase 4: Peer Learning & Study Groups
- [ ] Phase 5: Wellness Tracking
- [ ] Phase 6: Institutional Dashboards
- [ ] Final Phase: StudentOS Launcher