Spaces:
Sleeping
Sleeping
| # 🚀 Get Started with AI Mirror | |
| Welcome to AI Mirror! This guide will help you get up and running quickly. | |
| --- | |
| ## 📖 What is AI Mirror? | |
| AI Mirror is an AI-powered emotional intelligence platform that: | |
| - 🧠 Analyzes emotions in your text using advanced NLP | |
| - 📊 Creates beautiful visualizations of your emotional patterns | |
| - 🎨 Generates AI artwork representing your mood | |
| - 💡 Provides personalized insights and recommendations | |
| - 📄 Exports comprehensive PDF reports | |
| --- | |
| ## ⚡ Quick Start (5 Minutes) | |
| ### For Windows Users | |
| 1. **Open Two Command Prompts** | |
| 2. **In First Terminal** (Backend): | |
| ```bash | |
| cd "c:\Users\ZAEEM\Downloads\AI Mirror\CascadeProjects\windsurf-project" | |
| start-backend.bat | |
| ``` | |
| 3. **In Second Terminal** (Frontend): | |
| ```bash | |
| cd "c:\Users\ZAEEM\Downloads\AI Mirror\CascadeProjects\windsurf-project" | |
| start-frontend.bat | |
| ``` | |
| 4. **Open Browser**: http://localhost:5173 | |
| ### For macOS/Linux Users | |
| 1. **In First Terminal** (Backend): | |
| ```bash | |
| cd backend | |
| python3 -m venv venv | |
| source venv/bin/activate | |
| pip install -r requirements.txt | |
| python download_models.py | |
| uvicorn main:app --reload | |
| ``` | |
| 2. **In Second Terminal** (Frontend): | |
| ```bash | |
| cd frontend | |
| npm install | |
| npm run dev | |
| ``` | |
| 3. **Open Browser**: http://localhost:5173 | |
| --- | |
| ## 🎯 First Analysis | |
| 1. Click **"Start Analyzing"** on the home page | |
| 2. Enter your name (e.g., "Zayeem") | |
| 3. Add some text to analyze: | |
| ``` | |
| I'm feeling incredibly excited about this new AI project! | |
| The possibilities are endless and I can't wait to see what we can create. | |
| This technology is truly fascinating and inspiring. | |
| ``` | |
| 4. Click **"Analyze Emotions"** | |
| 5. Explore the results: | |
| - **Emotions Tab**: See emotion breakdown | |
| - **AI Insights Tab**: Read personalized summary | |
| - **Visualizations Tab**: View interactive charts | |
| - **Mood Art Tab**: See AI-generated artwork | |
| --- | |
| ## 🔑 Optional: Enable Full Features | |
| For AI-generated art and enhanced insights, add API keys: | |
| ### Get OpenAI API Key | |
| 1. Visit https://platform.openai.com/ | |
| 2. Sign up or log in | |
| 3. Go to API Keys → Create new key | |
| 4. Copy the key | |
| ### Get Gemini API Key | |
| 1. Visit https://makersuite.google.com/app/apikey | |
| 2. Create API key | |
| 3. Copy the key | |
| ### Add Keys to Backend | |
| 1. Navigate to `backend` folder | |
| 2. Copy `.env.example` to `.env` | |
| 3. Edit `.env` and add: | |
| ``` | |
| OPENAI_API_KEY=sk-your-openai-key-here | |
| GEMINI_API_KEY=your-gemini-key-here | |
| ``` | |
| 4. Restart backend server | |
| **Note**: App works without keys but with limited features. | |
| --- | |
| ## 📚 Documentation | |
| - **Quick Start**: `QUICKSTART.md` - Fastest way to run | |
| - **Setup Guide**: `SETUP.md` - Detailed installation | |
| - **Deployment**: `DEPLOYMENT.md` - Deploy to production | |
| - **Project Summary**: `PROJECT_SUMMARY.md` - Complete overview | |
| - **Contributing**: `CONTRIBUTING.md` - How to contribute | |
| --- | |
| ## 🎨 Features Overview | |
| ### 1. Emotion Detection | |
| - Detects 7 emotions: joy, sadness, anger, fear, surprise, neutral, disgust | |
| - 95%+ accuracy using BERT models | |
| - Real-time analysis | |
| ### 2. AI Insights | |
| - Personalized emotional summaries | |
| - Pattern recognition | |
| - Actionable recommendations | |
| - Powered by GPT/Gemini | |
| ### 3. Visualizations | |
| - Emotion pie chart | |
| - Intensity bar chart | |
| - Sentiment gauge | |
| - Emotion timeline | |
| - Radar chart | |
| ### 4. Mood Landscape Art | |
| - AI-generated nature landscapes | |
| - Weather/season matching emotions | |
| - High-quality 4K photography style | |
| - Pure nature scenes (no humans/animals) | |
| - Powered by DALL-E | |
| ### 5. PDF Reports | |
| - Comprehensive analysis | |
| - Professional formatting | |
| - Downloadable | |
| - Shareable | |
| --- | |
| ## 🛠️ Tech Stack | |
| **Backend**: Python, FastAPI, BERT, Transformers, Plotly | |
| **Frontend**: React, TailwindCSS, Framer Motion | |
| **AI**: OpenAI GPT, DALL-E, Google Gemini | |
| **Deployment**: Netlify, Render | |
| --- | |
| ## 📊 Example Use Cases | |
| ### Personal Development | |
| ``` | |
| Track your emotional patterns over time | |
| Identify triggers and trends | |
| Improve self-awareness | |
| ``` | |
| ### Content Creation | |
| ``` | |
| Analyze your writing tone | |
| Optimize messaging for your audience | |
| Ensure emotional consistency | |
| ``` | |
| ### Mental Health | |
| ``` | |
| Monitor emotional well-being | |
| Recognize patterns | |
| Share insights with therapist | |
| ``` | |
| ### Research | |
| ``` | |
| Sentiment analysis studies | |
| Emotion detection research | |
| NLP model evaluation | |
| ``` | |
| --- | |
| ## 🐛 Troubleshooting | |
| ### Backend won't start | |
| - Check Python version: `python --version` (need 3.9+) | |
| - Install dependencies: `pip install -r requirements.txt` | |
| - Check port 8000 is free | |
| ### Frontend won't start | |
| - Check Node version: `node --version` (need 18+) | |
| - Install dependencies: `npm install` | |
| - Clear cache: `npm cache clean --force` | |
| ### Models not downloading | |
| - Check internet connection | |
| - Run manually: `python download_models.py` | |
| - Wait 5-10 minutes for download | |
| ### API calls failing | |
| - Verify backend is running: http://localhost:8000/health | |
| - Check CORS settings | |
| - Verify API URL in frontend/.env | |
| --- | |
| ## 💡 Tips for Best Results | |
| 1. **Text Length**: 50-500 words works best | |
| 2. **Multiple Entries**: Add 3-5 texts for better insights | |
| 3. **Be Authentic**: Write naturally for accurate analysis | |
| 4. **Explore Tabs**: Check all result tabs for complete picture | |
| 5. **Download Report**: Save your analysis as PDF | |
| --- | |
| ## 🎯 Next Steps | |
| After getting started: | |
| 1. ✅ Try different types of text | |
| 2. ✅ Explore all visualization types | |
| 3. ✅ Generate and download a report | |
| 4. ✅ Add API keys for full features | |
| 5. ✅ Customize the code (it's open source!) | |
| 6. ✅ Deploy to production (see DEPLOYMENT.md) | |
| 7. ✅ Share your deployment! | |
| --- | |
| ## 📞 Need Help? | |
| - **Email**: zayeem.s.khateeb@gmail.com | |
| - **LinkedIn**: https://www.linkedin.com/in/zayeemkhateeb | |
| - **Issues**: Create a GitHub issue | |
| - **Docs**: Check other .md files in project | |
| --- | |
| ## 🌟 Show Your Support | |
| If you like AI Mirror: | |
| - ⭐ Star the repository | |
| - 🐦 Share on social media | |
| - 💬 Provide feedback | |
| - 🤝 Contribute improvements | |
| --- | |
| ## 🎉 You're Ready! | |
| You now have everything you need to start using AI Mirror. | |
| **Remember**: "Your words reflect more than you think" 🌈 | |
| Enjoy exploring your emotions with AI Mirror! | |
| --- | |
| **Developer**: Sayed Mohd Zayeem Khateeb | |
| **Project**: AI Mirror - Emotional Intelligence Visualizer | |
| **Version**: 1.0.0 | |