• 🎯 Overview
• ✨ Features
• 🛠️ Tech Stack
• 📸 Screenshots
• 🚀 Quick Start
• ⚙️ Detailed Setup
• 🎮 User Guide
• 💳 Payment Integration
• 🔧 Configuration
• 📱 Mobile Experience
• 🎓 Premium Features
• 👨‍💼 Admin Panel
• 🚀 Deployment
• 🤝 Contributing
• 📄 License

AI CareerMentor Kenya is a comprehensive career guidance platform specifically designed for Kenyan students navigating the Competency-Based Curriculum (CBC). Our AI-powered system provides personalized career advice, CBC pathway recommendations, professional CV generation, and advanced career development tools.

• High School Students (Form 1-4)
• CBC Students (Grade 4-12)
• University Students
• Job Seekers
• Career Changers
• Parents and Guardians

• AI Career Chatbot - Ask questions about CBC, careers, and education
• CV Generator - Create professional CVs with AI assistance
• CBC Pathway Explorer - Discover suitable Senior School pathways
• User Dashboard - Track your progress and activities
• Firebase Authentication - Secure login with Google or email

• AI Career Assessment - Comprehensive personality and career analysis
• AI Interview Preparation - Job-specific interview coaching
• AI Skill Analyzer - Skills gap analysis and development roadmap
• Advanced Analytics - Detailed progress tracking
• Priority Support - Enhanced customer service

• M-Pesa Integration - Seamless mobile payments
• Subscription Plans - Basic (KSh 300), Premium (KSh 500), Professional (KSh 1,000)
• Pay-per-use options available

• Python 3.8+ - Core programming language
• Flask - Web framework
• Firebase Admin SDK - Database and authentication
• OpenAI GPT-3.5 - AI language model
• Groq API - Fast AI responses (fallback)
• M-Pesa API - Payment processing

• HTML5 - Structure
• Tailwind CSS - Styling and responsive design
• JavaScript (ES6+) - Interactive functionality
• Firebase SDK - Client-side authentication
• Font Awesome - Icons

• Firebase Firestore - NoSQL database
• Firebase Authentication - User management
• Firebase Storage - File storage

• M-Pesa STK Push - Mobile payments
• Safaricom Developer Portal - API integration

┌─────────────────────────────────────────────────────────┐
│  🎓 AI CareerMentor Kenya                              │
│                                                         │
│  Your CBC Journey Starts Here                          │
│  Discover your potential with AI-powered career        │
│  guidance, personalized CBC pathway recommendations,    │
│  and professional CV generation.                        │
│                                                         │
│  [🚀 Get Started Free] [▶️ Learn More]                 │
│                                                         │
│  ✨ Features:                                           │
│  • AI Career Mentor                                    │
│  • AI CV Generator                                     │
│  • CBC Pathway Guide                                   │
│  • Premium AI Tools                                    │
└─────────────────────────────────────────────────────────┘

┌─────────────────────────────────────────────────────────┐
│  👤 Welcome, John Doe                    [🚪 Logout]   │
│                                                         │
│  📈 Quick Stats:                                       │
│  ┌─────────┬─────────┬─────────┐                       │
│  │ AI Chat │ CVs Gen │ Pathways│                       │
│  │   12    │    3    │    2    │                       │
│  └─────────┴─────────┴─────────┘                       │
│                                                         │
│  🤖 AI Career Mentor                                   │
│  ┌─────────────────────────────────────────────────┐   │
│  │ Hi! Ask me anything about CBC or careers!       │   │
│  │ [Type your question...] [📤 Send]               │   │
│  └─────────────────────────────────────────────────┘   │
│                                                         │
│  📄 AI CV Generator                                     │
│  📋 CBC Career Pathway Explorer                         │
│  💎 Premium AI Career Tools                             │
└─────────────────────────────────────────────────────────┘

┌─────────────────────────────────────────────────────────┐
│  💎 Premium AI Career Tools                             │
│                                                         │
│  ┌─────────────┬─────────────┬─────────────┐           │
│  │🧠 Assessment│🤝 Interview │📊 Skill     │           │
│  │             │   Prep      │   Analyzer  │           │
│  │10 Questions │Job-specific │Gap Analysis │           │
│  │Personality  │STAR Method  │Roadmap      │           │
│  │Analysis     │Tips         │Courses      │           │
│  │             │             │             │           │
│  │[Start Test] │[Prepare]    │[Analyze]    │           │
│  └─────────────┴─────────────┴─────────────┘           │
│                                                         │
│  [👑 Subscribe to Premium]                              │
└─────────────────────────────────────────────────────────┘

• Python 3.8 or higher
• Git
• Firebase account
• OpenAI API key
• M-Pesa developer account (optional)

# Clone the repository
git clone https://github.com/yourusername/ai-careermentor-kenya.git
cd ai-careermentor-kenya

# Install dependencies
pip install -r requirements.txt

# Set up environment variables
cp .env.example .env
# Edit .env with your API keys

python app.py

Visit http://localhost:5000 in your browser.

Create a .env file in the project root:

# OpenAI Configuration
OPENAI_API_KEY=your_openai_api_key_here
GROQ_API_KEY=your_groq_api_key_here
GROQ_MODEL=llama-3.3-70b-versatile

# Flask Configuration
SECRET_KEY=your_secret_key_change_this_in_production

# Admin Configuration
ADMIN_EMAIL=admin@careermentor.com
ADMIN_PASSWORD=admin123

# M-Pesa Configuration (Optional)
MPESA_CONSUMER_KEY=your_mpesa_consumer_key
MPESA_CONSUMER_SECRET=your_mpesa_consumer_secret
MPESA_BUSINESS_SHORTCODE=your_business_shortcode
MPESA_PASSKEY=your_mpesa_passkey
MPESA_CALLBACK_URL=https://your-domain.com/mpesa/callback
MPESA_ENVIRONMENT=sandbox

1. Create Firebase Project:

   • Go to Firebase Console
   • Create a new project
   • Enable Firestore Database
   • Enable Authentication

2. Download Service Account:

   • Go to Project Settings > Service Accounts
   • Generate new private key
   • Save as firebase_config.json in project root

3. Configure Authentication:

   • Enable Email/Password authentication
   • Enable Google authentication
   • Add your domain to authorized domains

1. Get API Key:

   • Visit OpenAI Platform
   • Create account and get API key
   • Add to .env file

2. Optional - Groq Setup:

   • Visit Groq Console
   • Get API key for faster responses
   • Add to .env file

1. Header Section:

   • Logo: Click to return to homepage
   • Login/Register: Access your account
   • Google Sign-in: Quick authentication

2. Hero Section:

   • "Get Started Free": Redirects to dashboard
   • "Learn More": Scrolls to features section

3. Features Section:

   • AI Career Mentor: Overview of chatbot
   • CBC Expertise: Curriculum knowledge
   • Instant Results: Speed and efficiency

4. Premium Features Section:

   • AI Career Assessment: Detailed description
   • AI Interview Prep: Interview coaching
   • AI Skill Analyzer: Skills development

5. CBC Explanation:

   • Understanding CBC: Curriculum overview
   • Key Benefits: Personalized learning paths

6. CV Generator Section:

   • Try Our AI CV Generator: Quick CV creation
   • Text Area: Describe yourself
   • Generate Button: Create CV preview
   • Download PDF: Get formatted CV

1. Header:

   • User Name: Shows logged-in user
   • Logout Button: Sign out securely

2. Quick Stats Cards:

   • AI Conversations: Number of chat interactions
   • CVs Generated: Number of CVs created
   • Pathways Explored: Number of pathway analyses

3. AI Career Mentor Chat:

   • Chat Interface: Real-time conversation
   • Input Field: Type your questions
   • Send Button: Submit your message
   • Chat History: Previous conversations

4. CBC Information Panel:

   • About CBC: Curriculum explanation
   • Scrollable Content: Detailed information

5. AI CV Generator Section:

   • Form Fields: Name, email, education, skills, interests
   • Generate Button: Create professional CV
   • Status Messages: Progress updates

6. CBC Career Pathway Explorer:

   • Description Field: Describe your interests
   • Discover Button: Generate pathway analysis
   • Result Display: Formatted pathway recommendations
   • Download PDF: Get pathway report

7. Premium AI Career Tools:

   • Assessment Card: Start career assessment
   • Interview Prep Card: Prepare for interviews
   • Skill Analyzer Card: Analyze your skills
   • Subscribe Button: Access premium features

1. Access: Click "Start Assessment" button

2. Modal Opens: 10 comprehensive questions

3. Answer Questions:

   • What activities do you enjoy most?
   • How do you prefer to learn?
   • What work environment appeals to you?
   • How do you handle challenges?
   • What motivates you most?
   • How do you work with others?
   • What subjects interest you?
   • How do you make decisions?
   • What are your strengths?
   • Where do you see yourself in 5 years?

4. Submit: Click "Get My Assessment"

5. Results: Comprehensive analysis including:

   • Personality Type Analysis (Big Five traits)
   • Learning Style Assessment
   • Career Interest Areas (Holland's RIASEC)
   • Strengths and Development Areas
   • Recommended CBC Pathways
   • Career Suggestions with salary expectations
   • Educational Roadmap
   • 2-Year Action Plan

1. Access: Click "Prepare for Interview" button

2. Fill Form:

   • Job Title: e.g., Software Developer, Marketing Manager
   • Industry: Technology, Healthcare, Finance, etc.
   • Experience Level: Entry, Mid, Senior

3. Generate: Click "Generate Interview Prep"

4. Results: Comprehensive guide including:

   • Common interview questions for the role
   • STAR method answers for behavioral questions
   • Industry-specific technical questions
   • Salary negotiation tips for Kenyan market
   • Company research suggestions
   • Follow-up email templates
   • Interview day checklist

1. Access: Click "Analyze Skills" button

2. Fill Form:

   • Current Skills: Describe your skills and experiences
   • Career Goal: e.g., Become a Data Scientist

3. Analyze: Click "Analyze My Skills"

4. Results: Detailed analysis including:

   • Skills Gap Analysis
   • Missing Skills for Career Goal
   • Skill Development Roadmap
   • Recommended Courses/Training in Kenya
   • Online Learning Resources
   • Certification Recommendations
   • Timeline for Skill Development
   • Networking Opportunities

1. Basic Plan - KSh 300/month:

   • 20 AI interactions/month
   • Basic CV generation
   • Pathway exploration
   • 1 premium feature/month

2. Premium Plan - KSh 500/month:

   • Unlimited AI interactions
   • All premium features
   • Priority support
   • Advanced analytics
   • PDF downloads

3. Professional Plan - KSh 1,000/month:

   • Everything in Premium
   • Bulk CV generation
   • Team management
   • Advanced analytics dashboard
   • API access

1. Select Plan: Choose subscription tier
2. Enter Phone Number: M-Pesa registered number
3. Initiate Payment: Click "Pay with M-Pesa"
4. M-Pesa Prompt: Complete payment on phone
5. Confirmation: Subscription activated
6. Access: Premium features unlocked

1. Firestore Rules:

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if request.auth != null;
    }
  }
}

2. Authentication Settings:
   • Enable Email/Password
   • Enable Google Provider
   • Set authorized domains

1. Sandbox Testing:

   • Use test phone: 254708374149
   • Test PIN: 0000
   • Business Shortcode: your_test_shortcode

2. Production Setup:

   • Apply for production access
   • Get production credentials
   • Set up SSL certificate
   • Configure callback URL

• Mobile-First: Optimized for smartphones
• Touch-Friendly: Large buttons and touch targets
• Fast Loading: Optimized for mobile networks
• Offline Support: Basic functionality without internet

1. Hamburger Menu: Collapsible navigation
2. Swipe Gestures: Natural mobile interactions
3. Touch Feedback: Visual feedback on touch
4. Keyboard Optimization: Mobile keyboard support

• 10 Comprehensive Questions: Covering personality, learning style, interests
• Big Five Personality Analysis: Scientific personality assessment
• Holland's RIASEC Model: Career interest mapping
• Learning Style Assessment: Visual, auditory, kinesthetic preferences
• CBC Pathway Recommendations: Based on assessment results
• Kenyan Salary Expectations: Local market insights
• 2-Year Action Plan: Specific steps for development

• Job-Specific Questions: Tailored to role and industry
• STAR Method Templates: Structured answer format
• Industry-Specific Technical Questions: Role-relevant queries
• Kenyan Salary Negotiation Tips: Local market advice
• Company Research Suggestions: Preparation strategies
• Follow-up Email Templates: Post-interview communication
• Interview Day Checklist: Practical preparation steps

• Skills Gap Analysis: Current vs. required skills
• Development Roadmap: Step-by-step progression
• Course Recommendations: Local institutions and programs
• Online Learning Resources: Free and paid options
• Certification Recommendations: Kenyan market relevance
• Timeline for Skill Development: Realistic milestones
• Networking Opportunities: Local professional networks

• URL: /admin
• Login with admin credentials
• Secure session management

1. Dashboard Overview:

   • Total users count
   • Total messages count
   • CV downloads count
   • Pathway downloads count
   • Daily statistics (last 7 days)

2. User Management:

   • View all registered users
   • User details and registration dates
   • Authentication providers
   • Activity tracking

3. Message Monitoring:

   • All AI conversations
   • User questions and AI responses
   • Timestamp tracking
   • Search and filter capabilities

4. Download Tracking:

   • CV download history
   • Pathway report downloads
   • User activity patterns
   • Usage analytics

5. Payment Monitoring:

   • Subscription status
   • Payment history
   • Revenue tracking
   • User upgrade patterns

# Install dependencies
pip install -r requirements.txt

# Set up environment
python setup_env.py
# Edit .env with your keys

# Run development server
python app.py

Perfect for: Quick deployment, zero configuration, free forever

• ✅ FREE - 750 hours/month forever
• ✅ 5 minute setup - Just connect GitHub
• ✅ Auto-deploy from Git
• ✅ Free SSL certificate

Quick Start:

1. Sign up at https://render.com (free, no credit card)
2. Connect GitHub repository
3. Create Web Service
4. Add environment variables
5. Deploy! 🎉

📖 Full Guide: See render_deploy.md for detailed steps

Your app will be at: https://your-app.onrender.com

Perfect for: Learning AWS, understanding cloud infrastructure

• ✅ FREE for first year - 750 hours/month
• ✅ t2.micro instance - Free tier eligible
• ✅ Full control - Learn Linux/SSH/AWS

Quick Start:

1. Launch EC2 t2.micro instance
2. Run: ./deploy_ec2.sh
3. Configure environment variables
4. Start service

📖 Full Guide: See FREE_TIER_DEPLOYMENT.md → AWS EC2 section

Cost: FREE (first year), then ~$7-10/month

Perfect for: Modern deployment platform

• ✅ $5 free credit/month
• ✅ Easy GitHub integration
• ✅ Auto SSL

Quick Start:

1. Sign up at https://railway.app
2. Deploy from GitHub
3. Add environment variables
4. Done!

📖 Full Guide: See FREE_TIER_DEPLOYMENT.md → Railway section

• Automatic scaling and load balancing
• Built-in monitoring
• Cost: ~$25-35/month

📖 Full Guide: See AWS_DEPLOYMENT_GUIDE.md → Method 1

• Full control and customization
• Cost: ~$7-15/month (after free tier)

📖 Full Guide: See AWS_DEPLOYMENT_GUIDE.md → Method 2

• FREE_TIER_QUICK_START.md - ⚡ Quick reference for free deployment
• FREE_TIER_DEPLOYMENT.md - 📖 Complete free tier guide
• render_deploy.md - 🎯 Step-by-step Render.com guide
• AWS_DEPLOYMENT_GUIDE.md - 🚀 Comprehensive AWS guide
• DEPLOYMENT_CHECKLIST.md - ✅ Pre-deployment checklist

Set all these in your deployment platform:

# Firebase
FIREBASE_API_KEY=your_firebase_api_key
FIREBASE_AUTH_DOMAIN=your_project.firebaseapp.com
FIREBASE_PROJECT_ID=your_project_id
FIREBASE_APP_ID=your_app_id

# AI Services
OPENAI_API_KEY=your_openai_key
GROQ_API_KEY=your_groq_key

# App Configuration
SECRET_KEY=your_strong_secret_key
ADMIN_EMAIL=admin@careermentor.com
ADMIN_PASSWORD=your_strong_password
FLASK_ENV=production

# M-Pesa (if using)
MPESA_CONSUMER_KEY=your_mpesa_key
MPESA_CONSUMER_SECRET=your_mpesa_secret
MPESA_BUSINESS_SHORTCODE=your_shortcode
MPESA_PASSKEY=your_passkey
MPESA_CALLBACK_URL=https://your-domain.com/mpesa/callback
MPESA_ENVIRONMENT=sandbox

Plus: Upload firebase_config.json to your server

New to deployment? → Try Render.com (5 minutes, free forever)
Want to learn AWS? → Try AWS EC2 Free Tier (free for first year)
Need scaling? → Upgrade to Elastic Beanstalk later

1. Fork the Repository
2. Create Feature Branch: git checkout -b feature/amazing-feature
3. Commit Changes: git commit -m 'Add amazing feature'
4. Push to Branch: git push origin feature/amazing-feature
5. Open Pull Request

• Follow PEP 8 style guide
• Write comprehensive tests
• Update documentation
• Ensure mobile compatibility
• Test payment integration

• Use GitHub Issues
• Provide detailed description
• Include screenshots if applicable
• Specify browser and device

This project is licensed under the MIT License - see the LICENSE file for details.

• Email: kibiwottkamoo@gmail.com
• Phone: +254 721 517 279
• Website: https://careermentor.co.ke

• API Documentation: /docs/api
• User Guide: /docs/user-guide
• Developer Guide: /docs/developer-guide

• GitHub Discussions: For questions and discussions
• Discord Server: Real-time community support
• Twitter: @CareerMentorKE