amauricunha commited on
Commit
eed86c5
·
verified ·
1 Parent(s): 757abab

Delete README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -130
README.md DELETED
@@ -1,130 +0,0 @@
1
- ---
2
- title: English Helper
3
- emoji: 🎓
4
- colorFrom: blue
5
- colorTo: purple
6
- sdk: gradio
7
- app_file: app.py
8
- pinned: false
9
- license: mit
10
- sdk_version: 5.49.1
11
- ---
12
-
13
- # 🎓 English Helper - AI English Learning Platform
14
-
15
- Sistema completo de aprendizado de inglês com inteligência artificial, curadoria de conteúdo personalizada e painel administrativo avançado.
16
-
17
- ## 🌟 Funcionalidades Principais
18
-
19
- - 🤖 **Chat IA**: Conversação em inglês com correções em tempo real
20
- - 📚 **Flashcards**: Geração automática baseada nas conversas
21
- - 📰 **Curadoria**: Artigos personalizados por nível de proficiência
22
- - 📅 **Plano de Estudos**: Cronograma adaptativo com IA
23
- - 🎵 **TTS**: Síntese de voz para pronunciação
24
- - 📊 **Analytics**: Dashboard administrativo completo
25
- - � **Multi-usuário**: Sistema de autenticação e perfis
26
-
27
- ## ⚙️ Configuração Obrigatória
28
-
29
- ### 🔐 Repository Secrets (Settings → Repository secrets)
30
-
31
- Configure estas variáveis como secrets no Hugging Face:
32
-
33
- | Secret Name | Obrigatório | Exemplo | Descrição |
34
- |-------------|-------------|---------|-----------|
35
- | `GROQ_API_KEY` | ✅ SIM | `gsk_abc123...` | API para conversação IA |
36
- | `GEMINI_API_KEY` | ✅ SIM | `AIzaSyA123...` | API para análise de conteúdo |
37
- | `SECRET_KEY` | ✅ SIM | `XYZ789...` | Chave de segurança Flask |
38
- | `BASE_URL` | ✅ SIM | `https://huggingface.co/spaces/amauricunha/englishhelper` | URL deste Space |
39
- | `ADMIN_USERNAME` | ✅ SIM | `admin` | Username do painel admin |
40
- | `ADMIN_PASSWORD` | ✅ SIM | `MinhaSenh@123!` | Senha do painel admin |
41
-
42
- ### 🔑 Como Gerar SECRET_KEY
43
-
44
- Execute no terminal:
45
- ```bash
46
- python3 -c "import secrets; print(secrets.token_urlsafe(32))"
47
- ```
48
-
49
- ## 🚀 Como Usar
50
-
51
- ### 1. **Aplicação Principal**
52
- Acesse diretamente a aplicação completa de aprendizado de inglês:
53
- - **Chat IA**: Pratique conversação em tempo real
54
- - **Flashcards**: Sistema de vocabulário interativo
55
- - **Curadoria**: Artigos personalizados por nível
56
- - **Planos**: Cronograma de estudos com IA
57
- - **Analytics**: Acompanhe seu progresso
58
-
59
- ### 2. **Painel Administrativo**
60
- Acesse `/admin` com suas credenciais para:
61
- - 👥 Gerenciar usuários
62
- - 📊 Visualizar analytics completo
63
- - 🔧 Configurar sistema
64
- - 📈 Monitorar uso de tokens
65
-
66
- ### 3. **Dashboard de Sistema**
67
- Acesse `/dashboard` para monitoramento técnico e status das APIs.
68
-
69
- ## 🛠️ Stack Tecnológico
70
-
71
- - **Frontend**: Gradio + HTML5/CSS3/JavaScript
72
- - **Backend**: Flask + Python 3.8+
73
- - **Database**: SQLite
74
- - **IA**: Groq API + Google Gemini
75
- - **Audio**: Google Text-to-Speech
76
- - **Deploy**: Hugging Face Spaces
77
-
78
- ## 📊 Arquitetura
79
-
80
- ```
81
- app.py # Entry point - Flask principal + Gradio dashboard
82
- flask_app.py # Aplicação Flask completa (porta 7860)
83
- admin_module.py # Painel administrativo avançado
84
- database.py # Sistema SQLite com 10+ tabelas
85
- templates/
86
- ├── admin.html # Interface administrativa
87
- └── index.html # Interface principal com rodapé
88
- ```
89
-
90
- ### 🏗️ **Nova Arquitetura (2024)**
91
- - **Flask Único**: Porta 7860 (aplicação completa)
92
- - **Dashboard HTML**: Rota `/dashboard` (monitoramento simples)
93
- - **Sem Conflitos**: Uma única aplicação web
94
- - **Links Integrados**: Rodapé com admin/status/dashboard
95
-
96
- ## 🔒 Segurança
97
-
98
- - ✅ Autenticação segura com hash de senhas
99
- - ✅ Proteção CSRF em formulários
100
- - ✅ Sanitização de dados de entrada
101
- - ✅ Rate limiting em APIs
102
- - ✅ HTTPS automático no HF Spaces
103
-
104
- ## 🎯 Primeiros Passos
105
-
106
- 1. **Configurar secrets** (obrigatório - veja tabela acima)
107
- 2. **Aguardar build** (~2-5 minutos)
108
- 3. **Acessar aplicação** - Vai direto para o sistema completo
109
- 4. **Criar conta** ou fazer login
110
- 5. **Admin**: Acesse `/admin` com suas credenciais
111
-
112
- ### 🔗 **URLs Principais**
113
- - **Principal**: `https://seu-space.hf.space/` → Aplicação completa
114
- - **Admin**: `https://seu-space.hf.space/admin` → Painel administrativo
115
- - **Status**: `https://seu-space.hf.space/auth/check` → Health check
116
- - **Dashboard**: `https://seu-space.hf.space/dashboard` → Monitor sistema
117
-
118
- ## 🆘 Troubleshooting
119
-
120
- ### Problemas Comuns:
121
- - **500 Error**: Verifique se todos os secrets obrigatórios estão configurados
122
- - **Admin não acessa**: Confirme ADMIN_USERNAME e ADMIN_PASSWORD
123
- - **APIs não funcionam**: Teste chaves Groq e Gemini individualmente
124
-
125
- ### Logs:
126
- Verifique `Settings → Logs` para debug detalhado.
127
-
128
- ---
129
-
130
- **🎓 English Helper** - Aprenda inglês com IA de forma inteligente e personalizada! 🚀