Spaces:
Sleeping
Sleeping
Update README.md
Browse files
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
|
| 13 |
|
| 14 |
-
|
| 15 |
|
| 16 |
-
|
| 17 |
|
| 18 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 19 |
|
| 20 |
-
##
|
| 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 |
-
###
|
| 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 |
-
|
| 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 |
-
|
| 39 |
-
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
|
|
|
|
|
|
|
|
|
| 43 |
|
| 44 |
-
##
|
| 45 |
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
5. **Track Progress**: Monitor your improvement over time
|
| 51 |
|
| 52 |
-
##
|
| 53 |
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
- **C1-C2**: Advanced to Proficiency
|
| 57 |
|
| 58 |
-
##
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 59 |
|
| 60 |
-
|
| 61 |
-
|
| 62 |
-
- **General/Social**: Everyday conversation and social interactions
|
| 63 |
|
| 64 |
-
## 🛠️
|
| 65 |
|
| 66 |
-
- **
|
| 67 |
-
- **
|
| 68 |
-
- **
|
| 69 |
-
- **
|
|
|
|
|
|
|
| 70 |
|
| 71 |
-
##
|
| 72 |
|
| 73 |
-
|
| 74 |
-
|
| 75 |
-
|
| 76 |
-
|
| 77 |
-
|
| 78 |
-
|
| 79 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 80 |
|
| 81 |
-
##
|
| 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 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 89 |
|
| 90 |
-
|
| 91 |
|
| 92 |
-
|
| 93 |
-
|
| 94 |
-
|
| 95 |
-
|
|
|
|
| 96 |
|
| 97 |
-
##
|
| 98 |
|
| 99 |
-
|
| 100 |
-
- **
|
| 101 |
-
- **
|
| 102 |
-
- **
|
| 103 |
-
- **Motivation Systems**: Progress tracking and achievement unlocking
|
| 104 |
|
| 105 |
-
##
|
| 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 |
-
**
|
|
|
|
| 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! 🚀
|