An interactive application to visualize and compare graph routing algorithms.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
Route-Finder is an interactive web application for visualizing and comparing graph-based routing algorithms. Users can add real-world waypoints on the map and analyze how different algorithms (A* and Nearest Neighbor) compute the optimal path.
This project was developed with the following main technologies:
To run the project, you need to have installed:
- Node.js
- NPM or Yarn
Instructions to install dependencies and start the project.
-
Get a free Google Maps API Key at https://developers.google.com/maps
-
Clone the repo
git clone https://github.com/Rondleysg/route-finder.git
-
Navigate to the project folder
cd route-finder -
Install dependencies
yarn
-
Configure environment variables by adding
.env.localfile to the project rootVITE_GOOGLE_MAPS_API_KEY=ENTER YOUR API KEY HERE VITE_RENDER_MAP=true
Instructions to run the project locally and use it.
-
Run the project locally
yarn dev
-
Access the application in your browser (normally at the address below)
http://localhost:5173/
-
If you prefer, you can load a predefined route by clicking the
Loadbutton, or manually add the route's starting point and its waypoints.
- Ability to change route visualization between A* and Nearest Neighbor algorithms.
- Visualize the computed route with clear path highlighting.
- View the total distance (in meters) of the route.
- Export the generated route to Google Maps for navigation.
- Add an address (waypoint) to the route.
- Add an address (waypoint) by clicking directly on the map.
- View list of addresses added to route.
- Remove an address (waypoint) from the route.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/new-feature) - Commit your Changes (
git commit -m 'feature: new feature') - Push to the Branch (
git push origin feature/new-feature) - Open a Pull Request
Rondley Gregório - @rondleyg - rondleyemail@gmail.com
Project Link: https://github.com/Rondleysg/route-finder