Spaces:
Sleeping
Sleeping
Delete README.md
Browse files
README.md
DELETED
|
@@ -1,120 +0,0 @@
|
|
| 1 |
-
---
|
| 2 |
-
title: English Helper
|
| 3 |
-
emoji: π
|
| 4 |
-
colorFrom: blue
|
| 5 |
-
colorTo: purple
|
| 6 |
-
sdk: docker
|
| 7 |
-
pinned: false
|
| 8 |
-
license: mit
|
| 9 |
-
---
|
| 10 |
-
|
| 11 |
-
# π English Helper - AI-Powered Language Learning Platform
|
| 12 |
-
|
| 13 |
-
## π Overview
|
| 14 |
-
|
| 15 |
-
English Helper is an advanced AI-powered English learning platform that combines intelligent content curation, interactive immersive environment, and personalized study planning to provide a comprehensive language learning experience.
|
| 16 |
-
|
| 17 |
-
## β¨ Key Features
|
| 18 |
-
|
| 19 |
-
### π€ AI-Powered Learning
|
| 20 |
-
- **Smart Conversation Practice**: Natural conversations with AI tutors
|
| 21 |
-
- **Personalized Content Curation**: AI-recommended articles and materials
|
| 22 |
-
- **Intelligent Study Planning**: Adaptive learning schedules
|
| 23 |
-
- **Real-time Feedback**: Pronunciation and grammar assistance
|
| 24 |
-
|
| 25 |
-
### π Interactive Learning Tools
|
| 26 |
-
- **Flashcard System**: Spaced repetition vocabulary learning
|
| 27 |
-
- **Writing Exercises**: Guided practice with AI feedback
|
| 28 |
-
- **Reading Comprehension**: Curated articles with difficulty assessment
|
| 29 |
-
- **Image Generation**: Visual vocabulary reinforcement
|
| 30 |
-
|
| 31 |
-
### π Advanced Analytics
|
| 32 |
-
- **Progress Tracking**: Detailed performance metrics
|
| 33 |
-
- **Study Analytics**: Time management and efficiency analysis
|
| 34 |
-
- **Personalized Recommendations**: AI-driven content suggestions
|
| 35 |
-
- **Achievement System**: Milestone tracking and motivation
|
| 36 |
-
|
| 37 |
-
### π Admin Panel
|
| 38 |
-
- **User Management**: Complete user administration
|
| 39 |
-
- **Token Usage Monitoring**: API cost tracking and analytics
|
| 40 |
-
- **System Health**: Real-time performance monitoring
|
| 41 |
-
- **Data Export**: CSV exports and reporting
|
| 42 |
-
|
| 43 |
-
## π Quick Start
|
| 44 |
-
|
| 45 |
-
1. **Create Account**: Register with your email
|
| 46 |
-
2. **Set Your Level**: Choose from A1 to C2
|
| 47 |
-
3. **Define Interests**: Select your learning focus areas
|
| 48 |
-
4. **Start Learning**: Use flashcards, chat with AI, read articles
|
| 49 |
-
5. **Track Progress**: Monitor your improvement over time
|
| 50 |
-
|
| 51 |
-
## π― Learning Levels Supported
|
| 52 |
-
|
| 53 |
-
- **A1-A2**: Basic to Elementary
|
| 54 |
-
- **B1-B2**: Intermediate to Upper-Intermediate
|
| 55 |
-
- **C1-C2**: Advanced to Proficiency
|
| 56 |
-
|
| 57 |
-
## π Learning Contexts
|
| 58 |
-
|
| 59 |
-
- **Professional/Business**: Corporate communication and presentations
|
| 60 |
-
- **Technical/IT**: Technology and software development terminology
|
| 61 |
-
- **General/Social**: Everyday conversation and social interactions
|
| 62 |
-
|
| 63 |
-
## π οΈ Technology Stack
|
| 64 |
-
|
| 65 |
-
- **Backend**: Python Flask with SQLite
|
| 66 |
-
- **Frontend**: Responsive HTML/CSS/JavaScript
|
| 67 |
-
- **AI APIs**: Groq (fast processing) + Google Gemini (advanced analysis)
|
| 68 |
-
- **Features**: Real-time chat, content curation, study planning
|
| 69 |
-
|
| 70 |
-
## π± Usage
|
| 71 |
-
|
| 72 |
-
### For Learners:
|
| 73 |
-
1. Register and set your English level
|
| 74 |
-
2. Use the conversation feature to practice speaking
|
| 75 |
-
3. Create and review flashcards for vocabulary
|
| 76 |
-
4. Read curated articles matching your interests
|
| 77 |
-
5. Follow your personalized study plan
|
| 78 |
-
6. Track your progress in the analytics dashboard
|
| 79 |
-
|
| 80 |
-
### For Administrators:
|
| 81 |
-
1. Access the admin panel at `/admin`
|
| 82 |
-
2. Monitor user activity and system health
|
| 83 |
-
3. Track API usage and costs
|
| 84 |
-
4. Export data for analysis
|
| 85 |
-
5. Manage users and content
|
| 86 |
-
|
| 87 |
-
## π§ Configuration
|
| 88 |
-
|
| 89 |
-
The app requires several environment variables to be set (configured automatically in Hugging Face):
|
| 90 |
-
|
| 91 |
-
- `GROQ_API_KEY`: For AI conversations
|
| 92 |
-
- `GEMINI_API_KEY`: For content analysis
|
| 93 |
-
- `SMTP_*`: For email functionality (optional)
|
| 94 |
-
- `ADMIN_*`: For administrative access
|
| 95 |
-
|
| 96 |
-
## π Educational Impact
|
| 97 |
-
|
| 98 |
-
English Helper leverages cutting-edge AI to provide:
|
| 99 |
-
- **Personalized Learning Paths**: Adaptive content based on user progress
|
| 100 |
-
- **Real-world Application**: Practical scenarios and contexts
|
| 101 |
-
- **Immediate Feedback**: Instant corrections and suggestions
|
| 102 |
-
- **Motivation Systems**: Progress tracking and achievement unlocking
|
| 103 |
-
|
| 104 |
-
## π Perfect For:
|
| 105 |
-
|
| 106 |
-
- **Students** preparing for English proficiency exams
|
| 107 |
-
- **Professionals** improving business English skills
|
| 108 |
-
- **Developers** learning technical English terminology
|
| 109 |
-
- **Anyone** wanting to improve their English systematically
|
| 110 |
-
|
| 111 |
-
## π Privacy & Security
|
| 112 |
-
|
| 113 |
-
- User data stored securely with SQLite
|
| 114 |
-
- Session management with encrypted cookies
|
| 115 |
-
- Admin access protected with authentication
|
| 116 |
-
- No data sharing with third parties
|
| 117 |
-
|
| 118 |
-
---
|
| 119 |
-
|
| 120 |
-
**Start your English learning journey with AI-powered assistance!** ππβ¨
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|