Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FranckNdame committed Oct 7, 2019
1 parent 33ff08a commit 3ce99d9
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 54 deletions.
79 changes: 26 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,41 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
# Path Algorithms Visualizer

## Available Scripts
![](public/PAV.png)

In the project directory, you can run:
## Overview

### `npm start`
An intuitive approach to path visualization algorithms using React!

Runs the app in the development mode.<br />
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
## Algorithms

The page will reload if you make edits.<br />
You will also see any lint errors in the console.
### Dijkstra's Algorithm

### `npm test`
![](public/edsger-w-dijkstra.jpeg)
Dijkstra's algorithm is an algorithm for finding the shortest paths between nodes in a graph. It was conceived by computer scientist Edsger W. Dijkstra in 1956 and published three years later.

Launches the test runner in the interactive watch mode.<br />
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
The algorithm exists in many variants. Dijkstra's original algorithm found the shortest path between two given nodes,[4] but a more common variant fixes a single node as the "source" node and finds shortest paths from the source to all other nodes in the graph, producing a shortest-path tree.
![](public/Dijkstra_Animation.gif)
For a given source node in the graph, the algorithm finds the shortest path between that node and every other. It can also be used for finding the shortest paths from a single node to a single destination node by stopping the algorithm once the shortest path to the destination node has been determined. For example, if the nodes of the graph represent cities and edge path costs represent driving distances between pairs of cities connected by a direct road (for simplicity, ignore red lights, stop signs, toll roads and other obstructions), Dijkstra's algorithm can be used to find the shortest route between one city and all other cities.

### `npm run build`
## Usage

Builds the app for production to the `build` folder.<br />
It correctly bundles React in production mode and optimizes the build for the best performance.
git clone the project and type `npm start` in the terminal.
Website available soon.

The build is minified and the filenames include the hashes.<br />
Your app is ready to be deployed!
## ToDO

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
- ~~Add Dijkstra's Algorithm~~
- Add DFS
- Add BFS
- Add A\* Search
- Improve User Interface
- Launch website
- ...

### `npm run eject`
## Author

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
FranckNdame, franck.mpouli@yahoo.com

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.
## Contributing

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.

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.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### 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
Forks, patches and other feedback are welcome.
Binary file added public/Dijkstra_Animation.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/PAV-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/edsger-w-dijkstra.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/Main/Header/NavigationBar.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export default class NavigationBar extends Component {
const { fixed } = this.state;
const { onVisiualizePressed, onClearPathPressed } = this.props;
return (
<Menu fixed="top" inverted>
<Menu fixed="top" inverted style={{ backgroundColor: "#061830" }}>
<Container>
<Menu.Item as="a" header>
<Image
Expand Down

0 comments on commit 3ce99d9

Please sign in to comment.