Skip to content

Latest commit

 

History

History
226 lines (154 loc) · 9.18 KB

README.md

File metadata and controls

226 lines (154 loc) · 9.18 KB

PathFinding-Visualizer: - A REACT APPLICATION

NodeJS NPM Made With React Build Status


check out live demo HERE

DFS visualization demo:

dfs

Overview:

This is a fun project on visualizing path finding algorithms i.e BFS, DFS, Dikstra’s , A* algorithm. This app is entirely built in react and below is the how the interface looks like.. Green box is the starting node and Red box is the end node. You can see the various algorithms below to visualize. Here design of grid is done using tables and set first node and second node colors using CSS properties. grid

Intro ..

Path finding algorithms plays a vital role in our daily life such as packets in computer networks , google maps uses a path finding algorthm to find the shortest path. So this project main idea is to visualize this path finding algorthms using react with the help of some css animations.

You can also follow my Medium BLOG for more understanding and details :)

Let's check out some intuition behind this algorithms for better insights.

Breadth First Search

  • Breadth First Search explores equally in all directions.
  • This is an incredibly useful algorithm, not only for regular traversal, but also for procedural map generation, flow field pathfinding, distance maps, and other types of map analysis.
  • This may be the algorithm of choice to identify nearby places of interest in GPS.
  • BFS guarantees the shortest path. Below is the result for Breadth first search: bfs

Depth First Search

  • Traverses by exploring as far as possible down each path before backtracking.
  • As useful as the BFS: DFS can be used to generate a topological ordering, to generate mazes, to traverse trees, to build decision trees, to discover a solution path with hierarchical choices…
  • DFS does not guarantee the shortest path. Below is how the DFS works dfs

Dijkstra

  • Dijkstra's Algorithm lets us prioritize which paths to explore. Instead of exploring all possible paths equally, it favors lower cost paths.
  • We can assign lower cost to encourage moving on roads while assigning high cost on highway to avoid them.
  • It is the algorithm of choice for finding the shortest path paths with multiple destinations. Below is the demo dikstra

A* (A-Star)

  • A* is a modification of Dijkstra's Algorithm that is optimized for a single destination.
  • Dijkstra's Algorithm can find paths to all locations; A* finds paths to one location. It prioritizes paths that seem to be leading closer to a goal.
  • In a game, we could set costs to be attracted or discouraged in going near some objects : how useful it is for an AI.
  • It is more or less the golden ticket or industry standard algorithm for all applications finding directions between two locations. Below is the demo of application: a

Now Let's drive into the code ..

Getting Started ..

First install node.js which comes with a bundle(npm+npx) to run javascript in local system. type following commands in the shell to create a react app

npx create-react-app my-app
cd my-app
npm start

npm start

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console. Below is the App.js component which is the root component for the react applications.

import React from 'react';
import './App.css';
import PathfindingVisualizer from './PathfindingVisualizer/PathfindingVisualizer';

function App() {
  return (
    <div className="App">
      <PathfindingVisualizer></PathfindingVisualizer>
    </div>
  );
}

export default App;

The PathfindingVisualizer component is imported and rendered in App.js.

I write everything related to the project in the pathfindingVisualizer component.

pathfindingVisualizer:

Here we jammed everything we need into this component such as GUI logic, animations logic , node objects structure and its properties, Some boolean values (isRunning, isStartNode, isFinishNode, isWallNode ), css properties , walls logic, implementing algorithms, mousehandlers Then the pathfinding algorithms are written in another folder and is imported into pathfindingVisualizer component.

import React, {Component} from 'react';
import Node from './Node/Node';
import {dijkstra} from '../algorithms/dijkstra';
import {AStar} from '../algorithms/aStar';
import {dfs} from '../algorithms/dfs';
import {bfs} from '../algorithms/bfs';

import './PathfindingVisualizer.css';

Then handle mouse events and some reusable components to make this application more friendly.

There are functionalities in pathfindingVisualizer component for creating initialgrid(), clearwalls(), CreateNode(), isGridClear(), clearGrid() etc ..

Below is the driver code to implement algorithms in the component!!

 visualize(algo) {
   if (!this.state.isRunning) {
     this.clearGrid();
     this.toggleIsRunning();
     const {grid} = this.state;
     const startNode =
       grid[this.state.START_NODE_ROW][this.state.START_NODE_COL];
     const finishNode =
       grid[this.state.FINISH_NODE_ROW][this.state.FINISH_NODE_COL];
     let visitedNodesInOrder;
     switch (algo) {
       case 'Dijkstra':
         visitedNodesInOrder = dijkstra(grid, startNode, finishNode);
         break;
       case 'AStar':
         visitedNodesInOrder = AStar(grid, startNode, finishNode);
         break;
       case 'BFS':
         visitedNodesInOrder = bfs(grid, startNode, finishNode);
         break;
       case 'DFS':
         visitedNodesInOrder = dfs(grid, startNode, finishNode);
         break;
       default:
         // should never get here
         break;
     }
     

If you want to work off of this base to create your own Pathfinding Visualizer, feel free to fork this project or to just copy-paste code.

Feel free to check out my other projects by going to My Portfolio Site.

Everything below this line was automatically generated by Create React App.

This project was bootstrapped with Create React App.

Deployment

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

I deploy this app in github pages. You can check out here : https://prudhvignv.github.io/pathFinderVisualizer/

LICENSE

MIT



For more documentation and understanding.. check out following links..

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify