amauricunha commited on
Commit
a459394
Β·
verified Β·
1 Parent(s): d009447

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +117 -226
README.md CHANGED
@@ -1,229 +1,120 @@
1
- # πŸŽ“ English Helper - Advanced AI Language Learning Platform
2
-
3
- ## 🌟 Visão Geral
4
-
5
- O English Helper Γ© uma plataforma avanΓ§ada de aprendizado de inglΓͺs que combina inteligΓͺncia artificial, curadoria de conteΓΊdo personalizada, e planejamento de estudos inteligente para oferecer uma experiΓͺncia de aprendizado imersiva e personalizada.
6
-
7
- ## πŸš€ Funcionalidades Principais
8
-
9
- ### 1. πŸ€– Motor de Curadoria de ConteΓΊdo Personalizado
10
- - **Busca Inteligente**: Encontre artigos e conteΓΊdos relevantes baseados em seus interesses
11
- - **AnΓ‘lise de ConteΓΊdo com IA**: AvaliaΓ§Γ£o automΓ‘tica de dificuldade e relevΓ’ncia
12
- - **Gerenciamento de Interesses**: Sistema dinΓ’mico de interesses do usuΓ‘rio
13
- - **RecomendaΓ§Γ΅es Personalizadas**: SugestΓ΅es baseadas no nΓ­vel de proficiΓͺncia e contexto
14
- - **Feeds RSS Integrados**: Acesso a fontes confiΓ‘veis de conteΓΊdo em inglΓͺs
15
- - **ExtraΓ§Γ£o de Texto**: Processamento automΓ‘tico de URLs para extraΓ§Γ£o de conteΓΊdo
16
-
17
- ### 2. 🎯 Ambiente de Imersão Interativo
18
- - **Sistema de Flashcards**: CriaΓ§Γ£o e revisΓ£o de vocabulΓ‘rio personalizado
19
- - **ConversaΓ§Γ£o com IA**: PrΓ‘tica de conversaΓ§Γ£o com feedback inteligente
20
- - **ExercΓ­cios de Escrita**: PrΓ‘tica guiada com correΓ§Γ£o automΓ‘tica
21
- - **GeraΓ§Γ£o de Imagens**: CriaΓ§Γ£o de imΓ‘genes contextuais para vocabulΓ‘rio
22
- - **SΓ­ntese de Voz**: PronΓΊncia e Γ‘udio com Google Text-to-Speech
23
- - **Contextos Personalizados**: AdaptaΓ§Γ£o para diferentes contextos (profissional, tΓ©cnico, social)
24
-
25
- ### 3. πŸ“Š Planejador de Estudos e Painel de AnΓ‘lise
26
- - **Planos de Estudo Personalizados**: Cronogramas adaptativos baseados em IA
27
- - **AnΓ‘lise de Progresso**: MΓ©tricas detalhadas de desempenho
28
- - **Sistema de Marcos**: Objetivos e checkpoints de progresso
29
- - **RecomendaΓ§Γ΅es Adaptativas**: Ajustes automΓ‘ticos baseados no desempenho
30
- - **Dashboard de Analytics**: VisualizaΓ§Γ΅es de progresso e estatΓ­sticas
31
- - **Tracking de Atividades**: Monitoramento detalhado de todas as atividades
32
-
33
- ## πŸ—οΈ Arquitetura TΓ©cnica
34
-
35
- ### Backend (Python/Flask)
36
- - **app.py**: AplicaΓ§Γ£o principal Flask com todas as rotas
37
- - **database.py**: Gerenciamento de banco de dados SQLite
38
- - **content_curator.py**: Motor de curadoria de conteΓΊdo
39
- - **study_planner.py**: Sistema de planejamento de estudos com IA
40
-
41
- ### Frontend (HTML/CSS/JavaScript)
42
- - **index.html**: Interface responsiva e interativa
43
- - **Design Moderno**: Interface limpa com Tailwind CSS
44
- - **SPA Experience**: NavegaΓ§Γ£o fluida sem recarregamento
45
-
46
- ### Banco de Dados
47
- ```sql
48
- -- Tabelas principais
49
- users -- UsuΓ‘rios e autenticaΓ§Γ£o
50
- user_settings -- ConfiguraΓ§Γ΅es personalizadas
51
- flashcards -- Sistema de flashcards
52
- study_sessions -- SessΓ΅es de estudo
53
- user_articles -- Artigos salvos pelo usuΓ‘rio
54
- user_interests -- Interesses do usuΓ‘rio
55
- content_recommendations -- RecomendaΓ§Γ΅es de conteΓΊdo
56
- study_plans -- Planos de estudo
57
- study_plan_activities -- Atividades dos planos
58
- user_analytics -- MΓ©tricas e analytics
59
- ```
60
-
61
- ### IntegraΓ§Γ΅es de IA
62
- - **Groq**: Processamento de linguagem natural rΓ‘pido
63
- - **Google Gemini**: AnΓ‘lise avanΓ§ada de conteΓΊdo
64
- - **Google Text-to-Speech**: SΓ­ntese de voz
65
- - **BeautifulSoup**: Web scraping inteligente
66
- - **FeedParser**: Processamento de feeds RSS
67
-
68
- ## πŸ› οΈ InstalaΓ§Γ£o e ConfiguraΓ§Γ£o
69
-
70
- ### PrΓ©-requisitos
71
- - Python 3.8+
72
- - Chaves de API:
73
- - `GROQ_API_KEY`: Para processamento de linguagem
74
- - `GEMINI_API_KEY`: Para anΓ‘lise de conteΓΊdo
75
- - `SECRET_KEY`: Para seguranΓ§a da sessΓ£o
76
-
77
- ### InstalaΓ§Γ£o
78
- ```bash
79
- # Clone o repositΓ³rio
80
- git clone <repository-url>
81
- cd englishhelper
82
-
83
- # Instale as dependΓͺncias
84
- pip install -r requirements.txt
85
-
86
- # Configure as variΓ‘veis de ambiente
87
- export GROQ_API_KEY="sua-chave-groq"
88
- export GEMINI_API_KEY="sua-chave-gemini"
89
- export SECRET_KEY="sua-chave-secreta"
90
-
91
- # Execute a aplicaΓ§Γ£o
92
- python run.py
93
- ```
94
-
95
- ### ConfiguraΓ§Γ£o de Desenvolvimento
96
- ```bash
97
- # Para desenvolvimento
98
- export FLASK_DEBUG=true
99
- python app.py
100
- ```
101
-
102
- ## πŸ“š Como Usar
103
-
104
- ### 1. CriaΓ§Γ£o de Conta
105
- 1. Acesse a aplicaΓ§Γ£o no navegador
106
- 2. Registre-se com email e senha
107
- 3. Confirme seu email (opcional)
108
- 4. Configure seu perfil (nΓ­vel, interesses, contexto)
109
-
110
- ### 2. Curadoria de ConteΓΊdo
111
- 1. **Buscar ConteΓΊdo**: Use a barra de busca para encontrar artigos
112
- 2. **Salvar Artigos**: Clique em "Salvar" para adicionar Γ  sua biblioteca
113
- 3. **Gerenciar Interesses**: Configure seus tΓ³picos de interesse
114
- 4. **RecomendaΓ§Γ΅es**: Receba sugestΓ΅es personalizadas baseadas em IA
115
-
116
- ### 3. Estudo Interativo
117
- 1. **Flashcards**: Crie e revise vocabulΓ‘rio
118
- 2. **ConversaΓ§Γ£o**: Pratique com o bot de IA
119
- 3. **Escrita**: Complete exercΓ­cios guiados
120
- 4. **Imagens**: Gere imagens para contextualizar vocabulΓ‘rio
121
-
122
- ### 4. Planejamento de Estudos
123
- 1. **Gerar Plano**: Configure seu nΓ­vel atual e objetivo
124
- 2. **Seguir Atividades**: Complete as atividades sugeridas
125
- 3. **Marcar Progresso**: Registre suas atividades concluΓ­das
126
- 4. **Acompanhar Analytics**: Monitore seu progresso
127
-
128
- ## 🎯 Níveis Suportados
129
-
130
- O sistema suporta todos os nΓ­veis do Quadro Europeu Comum:
131
- - **A1**: BΓ‘sico - vocabulΓ‘rio essencial e frases simples
132
- - **A2**: Elementar - situaΓ§Γ΅es cotidianas e tempos verbais bΓ‘sicos
133
- - **B1**: IntermediΓ‘rio - conversas mais complexas e opiniΓ΅es
134
- - **B2**: IntermediΓ‘rio Superior - textos complexos e apresentaΓ§Γ΅es
135
- - **C1**: AvanΓ§ado - textos acadΓͺmicos e expressΓ΅es sofisticadas
136
- - **C2**: ProficiΓͺncia - fluΓͺncia nativa e literatura
137
-
138
- ## πŸ”§ Contextos de Aprendizado
139
-
140
- ### Profissional/NegΓ³cios
141
- - VocabulΓ‘rio corporativo
142
- - ApresentaΓ§Γ΅es e relatΓ³rios
143
- - ComunicaΓ§Γ£o formal
144
- - Networking e reuniΓ΅es
145
-
146
- ### TΓ©cnico/TI
147
- - Terminologia tΓ©cnica
148
- - DocumentaΓ§Γ£o especializada
149
- - ComunicaΓ§Γ£o em equipes de desenvolvimento
150
- - Artigos de tecnologia
151
-
152
- ### Geral/Social
153
- - ConversaΓ§Γ£o cotidiana
154
- - MΓ­dias sociais
155
- - Entretenimento
156
- - Viagens e cultura
157
-
158
- ## πŸ“ˆ Analytics e MΓ©tricas
159
-
160
- ### MΓ©tricas Individuais
161
- - Tempo total de estudo
162
- - Palavras aprendidas
163
- - Artigos lidos
164
- - Atividades completadas
165
- - Progresso por nΓ­vel
166
-
167
- ### VisualizaΓ§Γ΅es
168
- - GrΓ‘ficos de progresso temporal
169
- - DistribuiΓ§Γ£o de atividades
170
- - ComparaΓ§Γ£o de performance
171
- - TendΓͺncias de aprendizado
172
-
173
- ## πŸš€ Funcionalidades AvanΓ§adas
174
-
175
- ### Sistema de RecomendaΓ§Γ΅es
176
- - AnΓ‘lise de padrΓ΅es de aprendizado
177
- - SugestΓ΅es adaptativas de conteΓΊdo
178
- - PersonalizaΓ§Γ£o baseada em performance
179
- - Machine Learning para otimizaΓ§Γ£o
180
-
181
- ### Planejamento Inteligente
182
- - Cronogramas adaptativos
183
- - Balanceamento de habilidades
184
- - Ajustes baseados em progresso
185
- - Marcos e objetivos personalizados
186
-
187
- ### Curadoria AutomΓ‘tica
188
- - Busca em tempo real
189
- - Filtros de qualidade
190
- - AnΓ‘lise de relevΓ’ncia
191
- - DiversificaΓ§Γ£o de fontes
192
-
193
- ## πŸ” SeguranΓ§a e Privacidade
194
-
195
- - AutenticaΓ§Γ£o segura com hash de senhas
196
- - SessΓ΅es criptografadas
197
- - Dados locais em SQLite
198
- - Sem compartilhamento de dados pessoais
199
- - Conformidade com boas prΓ‘ticas de seguranΓ§a
200
-
201
- ## πŸš€ Roadmap Futuro
202
-
203
- ### PrΓ³ximas Funcionalidades
204
- - [ ] IntegraΓ§Γ£o com mais APIs de IA
205
- - [ ] Sistema de gamificaΓ§Γ£o
206
- - [ ] Comunidade de learners
207
- - [ ] CertificaΓ§Γ΅es integradas
208
- - [ ] App mΓ³vel
209
- - [ ] IntegraΓ§Γ£o com calendΓ‘rios
210
- - [ ] Suporte a mΓΊltiplos idiomas
211
-
212
- ### Melhorias TΓ©cnicas
213
- - [ ] Cache inteligente
214
- - [ ] OtimizaΓ§Γ£o de performance
215
- - [ ] Testes automatizados
216
- - [ ] Deploy em cloud
217
- - [ ] Monitoramento avanΓ§ado
218
-
219
- ## 🀝 Contribuição
220
-
221
- Este Γ© um projeto de demonstraΓ§Γ£o das capacidades avanΓ§adas de IA para educaΓ§Γ£o. SugestΓ΅es e melhorias sΓ£o bem-vindas!
222
-
223
- ## πŸ“„ LicenΓ§a
224
-
225
- Projeto desenvolvido para fins educacionais e demonstraΓ§Γ£o de tecnologias avanΓ§adas de IA aplicadas ao aprendizado de idiomas.
226
 
227
  ---
228
 
229
- **English Helper** - Transformando o aprendizado de inglΓͺs com inteligΓͺncia artificial! πŸŽ“βœ¨
 
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!** πŸš€πŸ“šβœ¨