Eidolon-CognitiveTutor / README_SPACE.md
BonelliLab's picture
fix: Auto-detect demo mode and add deployment guides
e212f94
---
title: Eidolon Cognitive Tutor
emoji: 🧠
colorFrom: purple
colorTo: blue
sdk: gradio
sdk_version: 4.0.0
app_file: app.py
pinned: false
license: apache-2.0
---
# 🧠 Eidolon Cognitive Tutor
**Interactive AI Tutor with 6 Learning Modes, Adaptive Difficulty, and Gamification**
> Learn Anything, Your Way β€” Personalized, Interactive, Engaging
---
## πŸš€ Try It Now!
This Space runs in **Demo Mode** by default - no API keys required!
### Features
- πŸ“š **6 Learning Modes**: Socratic, ELI5, Technical, Analogy, Code, Standard
- 🎯 **Adaptive Difficulty**: 1-5 scale from Beginner to Expert
- 🎭 **Tutor Personas**: Friendly, Strict, Enthusiastic, Professional, Playful
- πŸ† **Gamification**: Achievements, streaks, progress tracking
- ⚑ **Interactive UI**: Typing animation, prompt enhancement, examples
---
## πŸ”§ Configuration (Optional)
To connect a real AI model instead of demo responses:
### Option 1: Set Environment Variables
1. Go to **Settings** β†’ **Variables and secrets**
2. Add these variables:
- `DEMO_MODE` = `0` (disable demo mode)
- `INFERENCE_API_URL` = your inference endpoint
- `INFERENCE_API_KEY` = your API key (if needed)
### Option 2: Keep Demo Mode (Default)
The Space works perfectly in demo mode! It shows:
- How learning modes adapt responses
- Difficulty scaling (1-5)
- Persona variations
- All UI features
**Demo mode is ideal for showcasing the platform without requiring API costs.**
---
## πŸ“š Documentation
- **[GitHub Repository](https://github.com/Zwin-ux/Eidolon-Cognitive-Tutor)** - Full source code
- **[Feature Showcase](https://github.com/Zwin-ux/Eidolon-Cognitive-Tutor/blob/main/FEATURES.md)** - Complete feature list
- **[Quick Start Guide](https://github.com/Zwin-ux/Eidolon-Cognitive-Tutor/blob/main/QUICKSTART.md)** - 30-second onboarding
---
## 🎯 What Makes This Special?
Unlike typical AI demos, this tutor offers:
- βœ… Multiple learning approaches (not one-size-fits-all)
- βœ… Difficulty adaptation (scales to your level)
- βœ… Personality customization (choose teaching style)
- βœ… Progress tracking (gamified journey)
- βœ… Full functionality in demo mode (no API required)
---
## πŸ› οΈ Tech Stack
- **Gradio 4.0+** - Interactive UI
- **FastAPI** - Backend API (Vercel deployment)
- **SQLite** - Conversation history
- **Vanilla JS** - Static UI (public/index.html)
---
## πŸ“– How to Use
1. **Select a Learning Mode** - Choose how you want to learn
2. **Adjust Difficulty** - Drag the slider (1=Beginner, 5=Expert)
3. **Pick a Persona** - Choose your tutor's style
4. **Ask Questions** - Type anything or click examples
5. **Track Progress** - Watch your stats grow!
---
## πŸ† Achievements to Unlock
- 🌟 **Getting Started** - Ask your first question
- πŸŽ“ **Curious Learner** - Ask 10 questions
- πŸ”₯ **Knowledge Seeker** - Ask 50 questions
- 🎨 **Mode Master** - Try all 6 learning modes
---
**Built with ❀️ for personalized learning**