Skip to content

EndlessMelody/Careermate

Repository files navigation

CareerMate Logo

AI-Powered Career Simulation Platform

Bridge the gap between academic learning and professional reality

Built with React FastAPI TypeScript License Deployed on Vercel

Live DemoDocumentationReport IssuesProject Report


About

CareerMate is an immersive, AI-driven career simulation platform designed with a Visual Novel-inspired interface. It provides students and career-shifters with a risk-free environment to navigate professional landscapes, make strategic decisions, and explore various career paths through interactive storytelling and gamified tasks.

Why CareerMate?

The transition from academic learning to professional practice presents significant challenges:

  • Lack of Real-World Experience: Students often lack exposure to actual workplace scenarios
  • Risk Aversion: Fear of making mistakes in real professional settings
  • Limited Guidance: Insufficient personalized mentorship and career guidance
  • Skill Gap: Mismatch between academic knowledge and industry requirements

CareerMate solves these problems by providing:

  • Immersive Simulations: Visual Novel-style career scenarios with branching narratives
  • AI-Powered Mentorship: Real-time guidance from advanced AI models (Groq & Gemini)
  • Hands-On Practice: Interactive workspace with real-world professional tasks
  • Safe Learning Environment: Practice without real-world consequences

Key Features

  • Immersive Simulations: Interactive career scenarios using a Visual Novel-style engine
  • AI-Driven Mentorship: Real-time feedback and guidance powered by Groq (Llama 3) and Google Gemini
  • Professional Workspace: Integrated development environment with Terminal, Code Editor, File Explorer, and Browser
  • Scene-Based Email System: Contextual emails that trigger tasks and advance storylines
  • Career Analytics: Comprehensive career fit reports and skill journey tracking
  • Community Feed: Social platform for sharing experiences and discussions
  • Course Marketplace: AI-powered courses for major preparation
  • Face Recognition: Secure authentication using VNPT SmartVision API
  • Glassmorphism UI: High-fidelity, responsive design optimized for all devices

Screenshots

Note: Add screenshots/GIFs of your Visual Novel interface, Task Management workspace, and Dashboard here.


Tech Stack

Component Technology
Frontend React 18, TypeScript, Vite, TailwindCSS, Framer Motion, Radix UI
Backend FastAPI (Python 3.11), SQLAlchemy, Alembic
Database PostgreSQL
AI Services Groq (Llama 3), Google Gemini
Auth/Vision VNPT SmartVision API, JWT
Infrastructure Docker, Docker Compose, Vercel
State Management Zustand, React Context
Code Editor Monaco Editor

Prerequisites

Before you begin, ensure you have the following installed:


Quick Start

Option 1: Docker Compose (Recommended)

The fastest way to get CareerMate running:

# Clone the repository
git clone https://github.com/EndlessMelody/Careermate.git
cd Careermate

# Start all services
docker-compose up -d --build

Access the application:

Option 2: Local Development

For detailed setup instructions, see the Setup Guide.

  1. Clone the repository

    git clone https://github.com/EndlessMelody/Careermate.git
    cd Careermate
  2. Configure environment variables (see Configuration section below)

  3. Start services

    # Backend
    cd backend
    pip install -r requirements.txt
    uvicorn app.main:app --reload
    
    # Frontend (in a new terminal)
    cd frontend
    npm install
    npm run dev

Configuration

Create a .env file in the project root with the following variables:

# --- AI Provider Configuration ---
# Options: groq (recommended for speed), gemini
AI_PROVIDER=groq
GROQ_API_KEY=your_groq_api_key_here

# Optional: Google Gemini
# GEMINI_API_KEY=your_gemini_api_key_here

# --- Application Security ---
SECRET_KEY=your-secret-key-change-in-production

# --- Database Configuration ---
POSTGRES_SERVER=localhost
POSTGRES_PORT=5432
POSTGRES_USER=careermate
POSTGRES_PASSWORD=careermate
POSTGRES_DB=careermate

# --- VNPT SmartVision (Optional) ---
VNPT_SMARTVISION_TOKEN_ID=your_token_id
VNPT_SMARTVISION_TOKEN_KEY=your_token_key
VNPT_SMARTVISION_ACCESS_TOKEN=your_access_token
VNPT_FACE_MATCH_THRESHOLD=0.85

# --- Frontend API URL ---
VITE_API_BASE_URL=http://localhost:8000

Note: Copy .env.example to .env and fill in your values. Never commit .env files to version control.


Project Structure

Careermate/
├── frontend/                    # React TypeScript frontend
│   ├── src/
│   │   ├── components/          # React components
│   │   │   ├── features/       # Feature modules (auth, dashboard, feed, etc.)
│   │   │   ├── layout/          # Layout components
│   │   │   ├── simulation/    # Simulation engine
│   │   │   └── workspace/      # Workspace components
│   │   ├── hooks/              # Custom React hooks
│   │   ├── utils/              # Utility functions
│   │   ├── types/              # TypeScript types
│   │   └── api/                # API client
│   └── package.json
│
├── backend/                     # FastAPI Python backend
│   ├── app/
│   │   ├── api/                # API endpoints
│   │   ├── core/               # Configuration
│   │   ├── models/             # Database models
│   │   ├── schemas/            # Pydantic schemas
│   │   ├── services/           # Business logic
│   │   └── utils/              # Utilities
│   ├── alembic/                # Database migrations
│   └── requirements.txt
│
├── database/                    # Database configuration
├── api-layer/                   # External API integrations
├── docs/                        # Documentation
├── scripts/                     # Development scripts
├── docker-compose.yml           # Container orchestration
└── README.md

Deployment

CareerMate is deployed on Vercel for frontend hosting, providing fast global CDN distribution and seamless CI/CD integration.

Live Deployment

  • Frontend: Vercel Deployment
  • Backend API: Deployed on your preferred hosting platform
  • API Documentation: Available at /docs endpoint

Deployment Features

  • Automatic Deployments: Every push to main branch triggers automatic deployment
  • Preview Deployments: Pull requests get preview URLs for testing
  • Global CDN: Fast content delivery worldwide via Vercel's edge network
  • Environment Variables: Secure configuration management through Vercel dashboard
  • Build Optimization: Automatic code splitting and performance optimization

For detailed deployment instructions, see the Deployment Guide.


Documentation


Roadmap

Short-Term (Q2-Q4 2025)

  • Enhanced AI capabilities with multi-turn conversation context
  • Additional task types for more career scenarios
  • Performance improvements and caching layer
  • Improved mobile experience

Medium-Term (Q1-Q3 2026)

  • VNPT Ecosystem Integration (SmartBot, eKYC, SmartVoice, SmartReader)
  • VNPT Cloud migration for 100% data sovereignty
  • Microservices architecture expansion
  • Multiplayer collaboration features

Long-Term Vision

  • Native mobile applications (iOS & Android)
  • Enterprise features (team management, admin dashboard)
  • Fine-tuned AI models for career guidance
  • Advanced analytics and predictive insights

Contributing

Contributions are welcome! If you'd like to contribute to CareerMate:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Please read our Contributing Guidelines (if available) for details on our code of conduct and the process for submitting pull requests.


Acknowledgments

  • VNPT: For providing the SmartVision API and infrastructure support
  • Groq: For ultra-fast AI inference capabilities
  • Google: For Gemini AI integration
  • Open Source Community: For the amazing tools and libraries that power CareerMate

Team

HCMUS_JobSeeker - Developed for the VNPT AI Hackathon 2025

  • Institution: Ho Chi Minh City University of Science (HCMUS)

License

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


Contact & Support


Made with love by HCMUS_JobSeeker

Star us on GitHub if you find this project helpful!

About

AI-powered career simulation platform bridging academic learning and professional reality through immersive Visual Novel-style scenarios and hands-on practice. Click the link below to see the demo version:

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Generated from figma/repo-template