Skip to content

README.md

Latest commit

 

History

History
108 lines (82 loc) · 3.77 KB

README.md

File metadata and controls

108 lines (82 loc) · 3.77 KB
Raw

🎓 Mentora AI — Your Intelligent Career Companion

React Gemini AI Node.js Firebase License

🌟 Overview

Mentora is a state-of-the-art, AI-powered career development platform designed to bridge the gap between academic learning and professional excellence. By leveraging the power of Google Gemini AI, Mentora provides users with a personalized, data-driven path to success—from resume optimization to skill mastery.

Whether you're a student preparing for your first internship or a professional looking to switch careers, Mentora offers the tools, insights, and roadmaps you need to navigate your journey with confidence.

✨ Key Features

  • 🔐 Secure Authentication: Robust user management powered by Firebase Auth (Email/Password & Social).
  • 📄 AI Resume Analysis: Upload your resume and receive instant feedback, score analysis, and improvement suggestions.
  • 🗺️ Personalized Roadmaps: Dynamic, timeline-based learning paths generated by AI based on your target role.
  • ✍️ Skill Assessments: Interactive quizzes to test your knowledge and validate your expertise in various domains.
  • 📊 Progress Dashboard: Visualize your growth with a premium, data-driven dashboard that tracks your roadmap completion.
  • 💼 Smart Recommendations: Get tailored job and internship suggestions that match your skills and career goals.
  • 🌌 Immersive UI: A modern, responsive interface featuring smooth Three.js animations and a dark-themed aesthetic.

🛠️ Tech Stack

Frontend

  • Framework: React.js (Vite)
  • Styling: Tailwind CSS (Modern, Responsive Design)
  • Animations: Three.js (Space-themed visual elements)
  • State Management: Context API
  • Auth: Firebase Authentication

Backend

  • Runtime: Node.js & Express.js
  • AI Integration: Google Gemini API (Generative AI)
  • Database: Google Firestore
  • Storage: Firebase Storage (for Resume uploads)

🚀 Getting Started

Prerequisites

  • Node.js (v18+)
  • Firebase Account
  • Google Gemini API Key

1. Clone the Repository

git clone https://github.com/shellyco-code/Mentora.git
cd Mentora

2. Server Setup

cd server
npm install
# Create a .env file and add your credentials (see .env.example)
npm run dev

3. Client Setup

cd client
npm install
# Create a .env file and add your Firebase config
npm run dev

📁 Project Structure

Mentora/
├── client/                 # React Frontend (Vite)
│   ├── src/
│   │   ├── components/     # UI Components
│   │   ├── pages/          # Application Pages
│   │   ├── context/        # Global State
│   │   └── services/       # API Integrations
├── server/                 # Node.js Express Backend
│   ├── services/           # AI Logic & Gemini Integration
│   ├── controllers/        # Route Handlers
│   └── config/             # Firebase & API Config

🛡️ License

Distributed under the MIT License. See LICENSE for more information.

Built with ❤️ for PST OJT 2025

Mentora AI — Elevating Careers through Intelligence