Skip to content

Latest commit

 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PathWise AI

PathWise AI is an intelligent learning roadmap generator that helps users achieve their educational goals. By simply entering a learning objective, the AI automatically generates a comprehensive, structured roadmap complete with modules, interactive lessons, and quizzes to track your progress.

This repository contains the full-stack application, divided into independent frontend and backend services.


📸 Screenshots

Landing Page Chat App
Landing Page Chat App

✨ Features

  • AI-Powered Roadmaps: Instantly generate personalized learning paths based on your specific goals.
  • Structured Learning Modules: Roadmaps are broken down into digestible modules and individual lessons.
  • Interactive Quizzes: Test your knowledge with dynamically generated quizzes at the end of each module.
  • Progress Tracking: Keep track of your completed lessons and quiz scores.
  • Full-Screen Reading Mode: Immerse yourself in the generated lesson content with a distraction-free full-screen UI.
  • Beautiful & Modern UI: Built with Shadcn UI and Tailwind CSS for a premium, accessible, and responsive design.
  • Independent Microservices: Fully decoupled frontend and backend for easy deployment and scalability.

🛠 Tech Stack

Frontend

Backend

  • Runtime: Node.js
  • Framework: Express.js
  • Database: MongoDB via Mongoose
  • Authentication: JWT (JSON Web Tokens)
  • AI Integration: OpenAI-compatible API endpoints (e.g. Claude, GPT-4)

📦 Project Structure

/
├── backend/                # Node/Express API Server
│   ├── src/                # Backend source code (routes, models, controllers)
│   ├── .env                # Backend environment variables
│   └── package.json        
│
├── frontend/               # React Frontend Application
│   ├── public/             # Static assets
│   ├── src/                # Frontend source code (components, routes, lib)
│   ├── .env                # Frontend environment variables
│   └── package.json
│
└── README.md               # This file

🚀 Installation & Setup

Prerequisites

  • Node.js (v18 or higher recommended)
  • A MongoDB instance (local or Atlas)
  • An AI API Key (e.g. OpenAI, Anthropic, or Deepshi)

1. Clone the repository

git clone https://github.com/himanchalkaushale/PathWise-AI.git
cd PathWise-AI

2. Set up the Backend

Open a terminal and navigate to the backend directory:

cd backend
npm install

Create a .env file in the backend directory with the following variables:

PORT=4000
MONGODB_URI=your_mongodb_connection_string
JWT_SECRET=your_super_secret_jwt_key
AI_BASE_URL=your_ai_base_url
AI_API_KEY=your_ai_api_key
AI_MODEL=your_ai_model

Start the backend server:

npm run dev

3. Set up the Frontend

Open a new terminal and navigate to the frontend directory:

cd frontend
npm install

Create a .env file in the frontend directory with the following variables:

# The port the frontend dev server will run on
PORT=5173

# The URL pointing to your running backend API
VITE_API_URL=http://localhost:4000

Start the frontend development server:

npm run dev

4. Open the App

The application will now be running! Open http://localhost:5173 in your browser to start exploring.

About

Pathwise an AI-powered learning roadmap generator. Turn any goal into a structured, personalized syllabus with on-demand markdown lessons, custom quizzes, and progress tracking.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages