amauricunha commited on
Commit
0cae077
·
verified ·
1 Parent(s): 9cc373f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +76 -84
README.md CHANGED
@@ -6,116 +6,108 @@ colorTo: purple
6
  sdk: gradio
7
  pinned: false
8
  license: mit
9
- sdk_version: 5.49.1
10
  ---
11
 
12
- # 🎓 English Helper - AI-Powered Language Learning Platform
13
 
14
- ## 🌟 Overview
15
 
16
- 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.
17
 
18
- ## Key Features
 
 
 
 
 
 
19
 
20
- ### 🤖 AI-Powered Learning
21
- - **Smart Conversation Practice**: Natural conversations with AI tutors
22
- - **Personalized Content Curation**: AI-recommended articles and materials
23
- - **Intelligent Study Planning**: Adaptive learning schedules
24
- - **Real-time Feedback**: Pronunciation and grammar assistance
25
 
26
- ### 📚 Interactive Learning Tools
27
- - **Flashcard System**: Spaced repetition vocabulary learning
28
- - **Writing Exercises**: Guided practice with AI feedback
29
- - **Reading Comprehension**: Curated articles with difficulty assessment
30
- - **Image Generation**: Visual vocabulary reinforcement
31
 
32
- ### 📊 Advanced Analytics
33
- - **Progress Tracking**: Detailed performance metrics
34
- - **Study Analytics**: Time management and efficiency analysis
35
- - **Personalized Recommendations**: AI-driven content suggestions
36
- - **Achievement System**: Milestone tracking and motivation
37
 
38
- ### 🔐 Admin Panel
39
- - **User Management**: Complete user administration
40
- - **Token Usage Monitoring**: API cost tracking and analytics
41
- - **System Health**: Real-time performance monitoring
42
- - **Data Export**: CSV exports and reporting
 
 
 
43
 
44
- ## 🚀 Quick Start
45
 
46
- 1. **Create Account**: Register with your email
47
- 2. **Set Your Level**: Choose from A1 to C2
48
- 3. **Define Interests**: Select your learning focus areas
49
- 4. **Start Learning**: Use flashcards, chat with AI, read articles
50
- 5. **Track Progress**: Monitor your improvement over time
51
 
52
- ## 🎯 Learning Levels Supported
53
 
54
- - **A1-A2**: Basic to Elementary
55
- - **B1-B2**: Intermediate to Upper-Intermediate
56
- - **C1-C2**: Advanced to Proficiency
57
 
58
- ## 🌍 Learning Contexts
 
 
 
 
 
59
 
60
- - **Professional/Business**: Corporate communication and presentations
61
- - **Technical/IT**: Technology and software development terminology
62
- - **General/Social**: Everyday conversation and social interactions
63
 
64
- ## 🛠️ Technology Stack
65
 
66
- - **Backend**: Python Flask with SQLite
67
- - **Frontend**: Responsive HTML/CSS/JavaScript
68
- - **AI APIs**: Groq (fast processing) + Google Gemini (advanced analysis)
69
- - **Features**: Real-time chat, content curation, study planning
 
 
70
 
71
- ## 📱 Usage
72
 
73
- ### For Learners:
74
- 1. Register and set your English level
75
- 2. Use the conversation feature to practice speaking
76
- 3. Create and review flashcards for vocabulary
77
- 4. Read curated articles matching your interests
78
- 5. Follow your personalized study plan
79
- 6. Track your progress in the analytics dashboard
 
 
 
 
80
 
81
- ### For Administrators:
82
- 1. Access the admin panel at `/admin`
83
- 2. Monitor user activity and system health
84
- 3. Track API usage and costs
85
- 4. Export data for analysis
86
- 5. Manage users and content
87
 
88
- ## 🔧 Configuration
 
 
 
 
89
 
90
- The app requires several environment variables to be set (configured automatically in Hugging Face):
91
 
92
- - `GROQ_API_KEY`: For AI conversations
93
- - `GEMINI_API_KEY`: For content analysis
94
- - `SMTP_*`: For email functionality (optional)
95
- - `ADMIN_*`: For administrative access
 
96
 
97
- ## 📚 Educational Impact
98
 
99
- English Helper leverages cutting-edge AI to provide:
100
- - **Personalized Learning Paths**: Adaptive content based on user progress
101
- - **Real-world Application**: Practical scenarios and contexts
102
- - **Immediate Feedback**: Instant corrections and suggestions
103
- - **Motivation Systems**: Progress tracking and achievement unlocking
104
 
105
- ## 🎓 Perfect For:
106
-
107
- - **Students** preparing for English proficiency exams
108
- - **Professionals** improving business English skills
109
- - **Developers** learning technical English terminology
110
- - **Anyone** wanting to improve their English systematically
111
-
112
- ## 🔒 Privacy & Security
113
-
114
- - User data stored securely with SQLite
115
- - Session management with encrypted cookies
116
- - Admin access protected with authentication
117
- - No data sharing with third parties
118
 
119
  ---
120
 
121
- **Start your English learning journey with AI-powered assistance!** 🚀📚✨
 
6
  sdk: gradio
7
  pinned: false
8
  license: mit
 
9
  ---
10
 
11
+ # 🎓 English Helper - AI English Learning Platform
12
 
13
+ Sistema completo de aprendizado de inglês com inteligência artificial, curadoria de conteúdo personalizada e painel administrativo avançado.
14
 
15
+ ## 🌟 Funcionalidades Principais
16
 
17
+ - 🤖 **Chat IA**: Conversação em inglês com correções em tempo real
18
+ - 📚 **Flashcards**: Geração automática baseada nas conversas
19
+ - 📰 **Curadoria**: Artigos personalizados por nível de proficiência
20
+ - 📅 **Plano de Estudos**: Cronograma adaptativo com IA
21
+ - 🎵 **TTS**: Síntese de voz para pronunciação
22
+ - 📊 **Analytics**: Dashboard administrativo completo
23
+ - � **Multi-usuário**: Sistema de autenticação e perfis
24
 
25
+ ## ⚙️ Configuração Obrigatória
 
 
 
 
26
 
27
+ ### 🔐 Repository Secrets (Settings → Repository secrets)
 
 
 
 
28
 
29
+ Configure estas variáveis como secrets no Hugging Face:
 
 
 
 
30
 
31
+ | Secret Name | Obrigatório | Exemplo | Descrição |
32
+ |-------------|-------------|---------|-----------|
33
+ | `GROQ_API_KEY` | SIM | `gsk_abc123...` | API para conversação IA |
34
+ | `GEMINI_API_KEY` | SIM | `AIzaSyA123...` | API para análise de conteúdo |
35
+ | `SECRET_KEY` | SIM | `XYZ789...` | Chave de segurança Flask |
36
+ | `BASE_URL` | ✅ SIM | `https://huggingface.co/spaces/amauricunha/englishhelper` | URL deste Space |
37
+ | `ADMIN_USERNAME` | ✅ SIM | `admin` | Username do painel admin |
38
+ | `ADMIN_PASSWORD` | ✅ SIM | `MinhaSenh@123!` | Senha do painel admin |
39
 
40
+ ### 🔑 Como Gerar SECRET_KEY
41
 
42
+ Execute no terminal:
43
+ ```bash
44
+ python3 -c "import secrets; print(secrets.token_urlsafe(32))"
45
+ ```
 
46
 
47
+ ## 🚀 Como Usar
48
 
49
+ ### 1. **Dashboard Principal**
50
+ Interface Gradio com status do sistema e links de acesso.
 
51
 
52
+ ### 2. **Sistema Completo**
53
+ Acesse as funcionalidades através dos links no dashboard:
54
+ - **Chat IA**: Pratique conversação
55
+ - **Flashcards**: Revise vocabulário
56
+ - **Curadoria**: Leia artigos personalizados
57
+ - **Planos**: Acompanhe seu progresso
58
 
59
+ ### 3. **Painel Administrativo**
60
+ Acesse `/admin` com suas credenciais configuradas nos secrets.
 
61
 
62
+ ## 🛠️ Stack Tecnológico
63
 
64
+ - **Frontend**: Gradio + HTML5/CSS3/JavaScript
65
+ - **Backend**: Flask + Python 3.8+
66
+ - **Database**: SQLite
67
+ - **IA**: Groq API + Google Gemini
68
+ - **Audio**: Google Text-to-Speech
69
+ - **Deploy**: Hugging Face Spaces
70
 
71
+ ## 📊 Arquitetura
72
 
73
+ ```
74
+ app.py # Interface Gradio (entrada HF Spaces)
75
+ flask_app.py # Sistema Flask completo
76
+ admin_module.py # Painel administrativo
77
+ database.py # Gerenciamento de dados
78
+ content_curator.py # Curadoria com IA
79
+ study_planner.py # Planos de estudo
80
+ templates/
81
+ ├── admin.html # Interface administrativa
82
+ └── index.html # Interface principal
83
+ ```
84
 
85
+ ## 🔒 Segurança
 
 
 
 
 
86
 
87
+ - Autenticação segura com hash de senhas
88
+ - ✅ Proteção CSRF em formulários
89
+ - ✅ Sanitização de dados de entrada
90
+ - ✅ Rate limiting em APIs
91
+ - ✅ HTTPS automático no HF Spaces
92
 
93
+ ## 🎯 Primeiros Passos
94
 
95
+ 1. **Configurar secrets** (obrigatório)
96
+ 2. **Aguardar build** (~2-5 minutos)
97
+ 3. **Testar dashboard** Gradio
98
+ 4. **Acessar sistema** via links
99
+ 5. **Login admin** com suas credenciais
100
 
101
+ ## 🆘 Troubleshooting
102
 
103
+ ### Problemas Comuns:
104
+ - **500 Error**: Verifique se todos os secrets obrigatórios estão configurados
105
+ - **Admin não acessa**: Confirme ADMIN_USERNAME e ADMIN_PASSWORD
106
+ - **APIs não funcionam**: Teste chaves Groq e Gemini individualmente
 
107
 
108
+ ### Logs:
109
+ Verifique `Settings → Logs` para debug detalhado.
 
 
 
 
 
 
 
 
 
 
 
110
 
111
  ---
112
 
113
+ **🎓 English Helper** - Aprenda inglês com IA de forma inteligente e personalizada! 🚀