PATHPLANNER

Empower your academic journey with seamless planning.

Built with the tools and technologies:

---

Table of Contents

• Overview
• Contributors
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Testing

---

Overview

PathPlanner is a powerful developer tool designed to streamline academic planning for students by integrating course management with a robust backend.

Why PathPlanner?

This project simplifies the academic journey for high school students, providing a seamless experience in course selection and management. The core features include:

• 🎯 Dependency Management: Ensures consistent package versions across environments, reducing "it works on my machine" issues.
• 📊 SQLite Database Integration: Efficiently manages course-related data, enhancing data retrieval and user experience.
• 🔗 Flask API: Provides a seamless bridge between frontend and backend, enabling structured data access for educational resources.
• 🖥️ User-Friendly Interface: Simplifies academic planning for students with intuitive navigation and dynamic course management.
• 🚀 Performance Monitoring: Captures key web vitals to optimize application performance and user experience.
• 🌐 Progressive Web App (PWA) Capabilities: Enhances usability across devices with offline capabilities and a native-like experience.

---

---

Contributors

Meet the team behind PathPlanner:

• Shukanth Jojodae
• Kanishk Kovuru
• Sharva Deodhar
• Nithin Seelan

We collaborated on ideation, design, and development to create a seamless academic planning experience for students.

---

Getting Started

Prerequisites

This project requires the following dependencies:

• Programming Language: JavaScript
• Package Manager: Npm, Pip

Installation

Build PathPlanner from the source and intsall dependencies:

1. Clone the repository:

   ❯ git clone https://github.com/shukanth/PathPlanner

2. Navigate to the project directory:

   ❯ cd PathPlanner

3. Install the dependencies:

Using npm:

❯ npm install

Using pip:

❯ pip install -r backend/requirements.txt

Usage

Run the project with:

Using npm:

npm start

Using pip:

python {entrypoint}

Testing

Pathplanner uses the {test_framework} test framework. Run the test suite with:

Using npm:

npm test

Using pip:

pytest

---

⬆ Return

---