Skip to content

IfeOlulesi/path-pilot

Repository files navigation

PathPilot

Netlify Status

Ever wondered how Google Maps always knows the "best" route from Point A to Point B? At the core is a pathfinding algorithm in action.

PathPilot allows you to interact with various pathfinding algorithms and learn how they work in practice!

🚀 Demo

🌐 Live Demo

View Live Project

🎥 Video Demo

Path.Pilot.Demo.1.mp4

📦 Installation

  1. Clone the repository:
git clone https://github.com/your-username/your-repo-name.git
  1. Navigate to the project directory:
cd path-pilot
  1. Install dependencies:
  npm install

🎮 Usage

To run the development server:

npm run dev

To build for production:

npm run build

To preview the production build:

npm run preview

🗺️ Roadmap

🟢 Completed

  • Initial project setup
  • Basic UI components
  • Algorithm visualization
  • Performance optimizations

🟡 In Progress

  • Mobile responsive design for maze
  • Documentation improvements
  • Settings
    • change cell width
    • change visualization speed

🔴 Planned

  • Depth-First Search
  • A*
  • Dijkstra
  • Greedy best-first search
  • Swarm
  • Convergent swarm
  • Bi-directional swarm
  • Key bindings for tools
  • Tutorial
  • Credits
  • Re-write clear maze logic

🤔 Under Consideration

  • Light/Dark mode
  • 3D visualization for maze
  • Zoom/Pan tools
  • Use icons for start/finish

🛠️ Tech Stack

  • React & Vite
  • Tailwind & DaisyUI
  • Zustand
  • TypeScript

🤝 Contributing

Contributions, issues, and feature requests are welcome!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feat/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feat/AmazingFeature)
  5. Open a Pull Request