Skip to content

Commit c82518e

Browse files
author
Shawn Toubeau
committed
Adds to readme + demo video
1 parent a2bc6bd commit c82518e

File tree

2 files changed

+48
-19
lines changed

2 files changed

+48
-19
lines changed

README.md

+47-17
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,55 @@
11
# Path2Finding Visualizer
2+
23
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
4+
35
[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)
6+
47
<!-- ALL-CONTRIBUTORS-BADGE:END -->
8+
59
## A Pathfinding Algorithm Visualization Tool
610

7-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
11+
Path2Finding is a pathfinding algorithm visualizer that focuses on teaching the user how pathfinding algorithm work. It allows the user to modify the maze, change the algorithm, and see how each of them perform. We also offer quick information about each algorithm to try and give a deeper understanding of the logic behind them.
12+
13+
## Features
14+
15+
- Start/stop the visualization
16+
- Select an algorithm (BFS, DFS, A\*, Dijkstra's)
17+
- Set a visualization speed (x0.5, x1, x1.5, x2)
18+
- Change the grid size (minimum 20 x 20)
19+
- Move start and end points
20+
- Randomize wall placement
21+
- Place/remove walls
22+
- Clear the grid
23+
- Save and load a maze
24+
- View information about each algorithm
25+
26+
## Getting Started
27+
28+
### Setup
29+
30+
1. Install [Node.js](https://nodejs.org/en/) and [Yarn](https://classic.yarnpkg.com/en/docs/install)
31+
32+
2. Clone this repository to your local computer and install its dependencies
33+
34+
```bash
35+
> git clone https://github.com/path2finding/visualizer.git
36+
> cd visualizer
37+
> yarn
38+
```
39+
40+
### Run
41+
42+
1. From the root project directory, start the application
43+
44+
```bash
45+
> yarn start
46+
```
47+
48+
2. A browser window should open once started but if not you can access it here: [http://localhost:3000/](http://localhost:3000/)
49+
50+
## Demo Video
51+
52+
https://youtu.be/6Yoa2gQcspA
853

954
## Available Scripts
1055

@@ -38,22 +83,6 @@ Your app is ready to be deployed!
3883

3984
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
4085

41-
### `yarn eject`
42-
43-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
44-
45-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
46-
47-
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
48-
49-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
50-
51-
## Learn More
52-
53-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
54-
55-
To learn React, check out the [React documentation](https://reactjs.org/).
56-
5786
## Contributors ✨
5887

5988
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -72,6 +101,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
72101

73102
<!-- markdownlint-enable -->
74103
<!-- prettier-ignore-end -->
104+
75105
<!-- ALL-CONTRIBUTORS-LIST:END -->
76106

77107
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,7 @@
4949
"start": "react-scripts start",
5050
"build": "react-scripts build",
5151
"test": "react-scripts test",
52-
"test:ci": "export CI=true && react-scripts test",
53-
"eject": "react-scripts eject"
52+
"test:ci": "export CI=true && react-scripts test"
5453
},
5554
"eslintConfig": {
5655
"extends": "react-app"

0 commit comments

Comments
 (0)