Skip to content

Latest commit

Β 

History

15 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ’» English Tutor for Developers

An AI-powered English tutor specifically designed for software developers who want to improve their technical English communication skills in professional workplace scenarios.

English Tutor Dashboard

✨ Features

🎯 Real Workplace Scenarios

Practice English in authentic software development contexts:

Scenarios Selection

  • Daily Standups - Share updates, discuss blockers
  • Code Reviews - Provide feedback, suggest improvements
  • Technical Interviews - Answer questions, explain solutions
  • Debugging Sessions - Communicate issues and solutions
  • Project Planning - Discuss requirements and timelines
  • Client Meetings - Present technical solutions
  • Architecture Discussions - Design system architecture
  • Deployment Issues - Handle production problems

Chat Interface

πŸ€– AI-Powered Learning

Using DeepSeek API for intelligent analysis:

AI Corrections Example

  • Grammar Corrections - Instant feedback on mistakes
  • Vocabulary Enhancement - Learn technical terminology
  • Style Improvements - Professional communication tips
  • Context-Aware Responses - Scenario-specific conversations

πŸ“ Personalized Grammar Quizzes

Quiz Interface

  • AI-Generated Questions - Based on your most common mistakes
  • Adaptive Learning - Questions target your weak areas
  • Detailed Explanations - Learn why answers are correct
  • Progress Tracking - Monitor quiz performance over time
  • Focus Area Recommendations - Know what to practice next

Quiz Results

πŸ€– AI Personal Analysis Reports

AI Report Dashboard

  • Comprehensive Skill Assessment - Detailed analysis of your English abilities
  • Strengths & Weaknesses - Identify what you do well and what needs work
  • Grammar Mastery Tracking - See which topics you've mastered
  • Personalized Learning Path - Step-by-step improvement plan
  • Learning Style Insights - Understand how you learn best
  • Actionable Recommendations - Specific steps to improve faster

Personal Analysis Charts

πŸ“Š Advanced Analytics Dashboard

Analytics Overview

  • Mistake Pattern Analysis - Identify your most common errors
  • Vocabulary Growth Tracking - Monitor words learned over time
  • Scenario Performance - See which situations need more practice
  • Progress Visualization - Charts and metrics to track improvement
  • Personalized Recommendations - AI suggestions for focused learning

🌐 Bilingual Support (English-Spanish)

  • Real-time Translation - Translate AI responses and corrections
  • Bilingual Interface - Switch languages with one click
  • Enhanced Translation - Multiple translation services with fallbacks
  • Technical Term Dictionary - Specialized vocabulary translations
  • Cultural Context - Understand professional communication differences

πŸ“ˆ Progress Tracking & History

  • Conversation History - Review all your practice sessions
  • Vocabulary Management - Track and review learned words
  • Detailed Corrections - See all grammar improvements over time
  • Export Functionality - Save your learning data

πŸš€ Quick Start

Prerequisites

Installation

  1. Clone the repository

    git clone https://github.com/CarlosMaroRuiz/EnglishForDevelopers.git
    cd EnglishForDevelopers
  2. Install dependencies

    pip install -r requirements.txt
  3. Set up environment variables

    cp example.env .env
    # Edit .env file with your API keys

    Your .env file should contain:

    DEEPSEEK_API_KEY=your_deepseek_api_key_here
    SECRET_KEY=your_secret_key_for_flask_sessions
  4. Test API connection (recommended)

    python test.py
  5. Run the application

    python app.py
  6. Open your browser Navigate to http://localhost:5000

πŸ—οΈ Project Structure

english-tutor-developers/
β”œβ”€β”€ app.py                 # Main Flask application
β”œβ”€β”€ config.py             # Configuration settings
β”œβ”€β”€ requirements.txt      # Python dependencies
β”œβ”€β”€ test.py              # API connection testing
β”œβ”€β”€ .gitignore           # Git ignore rules
β”œβ”€β”€ example.env          # Environment variables template
β”œβ”€β”€ english_tutor.db     # SQLite database (auto-created)
β”œβ”€β”€ images/              # Application screenshots
β”‚   β”œβ”€β”€ home.jpeg        # Main dashboard overview
β”‚   β”œβ”€β”€ home2.jpeg       # AI corrections and features
β”‚   β”œβ”€β”€ home3.jpeg       # Personal analysis charts
β”‚   β”œβ”€β”€ stories.jpeg     # Scenarios selection
β”‚   β”œβ”€β”€ stories2.jpeg    # Chat interface
β”‚   β”œβ”€β”€ quizz.jpeg       # Quiz interface
β”‚   β”œβ”€β”€ value_quizz.jpeg # Quiz results and scoring
β”‚   β”œβ”€β”€ ai_report.jpeg   # AI analysis reports
β”‚   └── analitics.jpeg   # Analytics dashboard
β”œβ”€β”€ services/            # Business logic layer
β”‚   β”œβ”€β”€ __init__.py      # Services package init
β”‚   β”œβ”€β”€ database.py      # Database operations
β”‚   β”œβ”€β”€ ai_service.py    # DeepSeek AI integration
β”‚   └── business_service.py # Core business logic
β”œβ”€β”€ routes.py            # Flask routes and endpoints
└── templates/           # HTML templates
    β”œβ”€β”€ base.html        # Base template with navigation
    β”œβ”€β”€ index.html       # Home page with scenarios
    β”œβ”€β”€ chat.html        # Interactive chat interface
    β”œβ”€β”€ quiz.html        # Grammar quiz interface
    β”œβ”€β”€ report.html      # AI personal analysis report
    β”œβ”€β”€ analytics.html   # Progress dashboard
    β”œβ”€β”€ vocabulary.html  # Vocabulary manager
    └── history.html     # Conversation history

πŸ› οΈ Technology Stack

  • Backend: Flask (Python)
  • Database: SQLite with comprehensive analytics tables
  • AI Integration: DeepSeek API for natural language processing
  • Frontend: HTML5, CSS3, JavaScript (Vanilla)
  • Styling: Tailwind CSS with custom animations
  • Translation: MyMemory Translation API with fallback dictionaries
  • Architecture: Service-oriented architecture with separation of concerns

πŸ“± Usage Guide

1. Home Dashboard

  • Scenario Selection: Choose from 8 different workplace scenarios
  • Quick Access: Jump directly to practice or quizzes
  • Progress Overview: See your learning statistics at a glance

2. Interactive Conversations

  • Type Messages: Practice English in realistic work situations
  • AI Responses: Get contextual replies that continue the conversation
  • Instant Feedback: Receive corrections and suggestions in real-time
  • Translation Support: Translate messages and feedback to Spanish

3. Personalized Quizzes

  • Adaptive Questions: Based on your conversation mistakes
  • Multiple Choice: Technical grammar questions with explanations
  • Immediate Results: See your score and detailed feedback
  • Focus Areas: Identify specific topics to practice

4. AI Analysis Reports

  • Comprehensive Assessment: Detailed analysis of your English skills
  • Visual Progress: Charts showing your improvement over time
  • Learning Path: Step-by-step plan for continued improvement
  • Bilingual Support: View reports in English or Spanish

5. Analytics Dashboard

  • Mistake Patterns: Identify your most common errors
  • Performance Tracking: Monitor improvement across scenarios
  • Vocabulary Growth: Track technical terms learned
  • Recommendations: AI-generated suggestions for focused practice

6. Progress Management

  • Conversation History: Review all your practice sessions
  • Vocabulary Library: Manage and review learned words
  • Export Data: Save your progress and analytics

πŸ§ͺ Testing Your Setup

Run the comprehensive test script:

python test.py

This will:

  • βœ… Verify your DeepSeek API key is configured correctly
  • βœ… Test basic API connectivity and response handling
  • βœ… Validate JSON response parsing for grammar analysis
  • βœ… Confirm the application is ready for full functionality

πŸ”§ Configuration

Environment Variables

Variable Description Required Default
DEEPSEEK_API_KEY Your DeepSeek API key for AI functionality Yes -
SECRET_KEY Flask session secret key for security Yes Auto-generated

Database Schema

The application automatically creates and manages SQLite tables for:

  • conversations - Chat history with AI responses
  • grammar_mistakes - Detailed error tracking and patterns
  • vocabulary - Technical terms with definitions and examples
  • user_progress - Learning analytics and improvement metrics
  • quiz_results - Quiz performance and detailed results
  • quiz_questions - AI-generated personalized questions
  • recommendations - AI-powered learning suggestions

🌟 Key Features in Detail

Advanced AI Analysis

  • Context-Aware Corrections: Grammar fixes specific to technical communication
  • Professional Vocabulary: Industry-specific term suggestions
  • Cultural Communication: Tips for professional workplace interactions
  • Pattern Recognition: Identifies your most common mistake types

Intelligent Quiz Generation

  • Mistake-Based Questions: Targets your specific problem areas
  • Difficulty Adaptation: Adjusts based on your performance level
  • Comprehensive Explanations: Learn why answers are correct or incorrect
  • Progress Integration: Results feed back into your overall analytics

Bilingual Learning Support

  • Real-Time Translation: Instant Spanish translations for all content
  • Technical Dictionaries: Specialized IT/development term translations
  • Cultural Context: Professional communication differences between languages
  • Fallback Systems: Multiple translation sources for reliability

Comprehensive Progress Tracking

  • Visual Analytics: Charts and graphs showing improvement trends
  • Detailed History: Complete record of all conversations and corrections
  • Export Capabilities: Save your data for external analysis
  • Performance Metrics: Quantified measures of your English improvement

πŸ“Š Analytics & Insights

The application provides detailed insights into your learning:

  • Conversation Quality: Track improvement in natural communication
  • Grammar Mastery: Monitor which grammar topics you've mastered
  • Vocabulary Expansion: See your technical vocabulary growth
  • Scenario Performance: Identify which work situations need more practice
  • Learning Velocity: Measure how quickly you're improving
  • Mistake Reduction: Track decreasing error rates over time

πŸ”„ Recent Updates

Version 2.0 Features

  • AI Personal Reports: Comprehensive skill analysis with learning paths
  • Advanced Quizzes: Personalized questions based on your mistakes
  • Enhanced Analytics: Detailed progress tracking and visualization
  • Bilingual Interface: Full Spanish translation support
  • Improved Architecture: Service-oriented design for better maintainability
  • Better Error Handling: More robust API integration and fallbacks

πŸ“ License

About

AI-powered English conversation trainer designed for technical professionals. Features workplace scenarios (code reviews, standups, interviews), real-time grammar corrections, vocabulary building, progress analytics, and Spanish translation support.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages