Skip to content

Commit 5e4604f

Browse files
committed
📚 (docs) Updated README.md
Updated README.md to include details of the project and steps to be followed for contributing to the project.
1 parent b03690f commit 5e4604f

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,67 @@
1+
# React Todo List Application
2+
3+
Graph algorithm Visualizer application for tracing Warshall and Floyds Algorithm and visualize them using graphs.
4+
5+
## About Project
6+
7+
The application allows user to enter adjacency matrices as input and calculates the transitive closure in case of Warshall algorithm and the shortest path between each node for Floyds Algorithm. Then the output of the algorithm is pictorially represented using Graphs rendered using Cytoscape.js. The entire application is build using React and other supported packages.
8+
9+
## Getting Started
10+
11+
A working installation of `Node.js`, `npm` and `Git` verison control system is enough to start the project.
12+
Instructions for Node installation can be found [here](https://nodejs.org/en/download/).
13+
Instructions for Git installation can be found [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
14+
NPM - a package manager for node is installed with Node.js.
15+
16+
### Installation
17+
18+
This project is built on the [**React**](https://reactjs.org/) a JavaScript library for building user interfaces.
19+
20+
1. Clone the project from GitHub using the following command.
21+
22+
```
23+
git clone https://github.com/abhayhk2001/ReactDjango-Todo
24+
```
25+
26+
2. Move into the created directory and start the native terminal in this directory. Install the required node modules for running the project.
27+
28+
```
29+
$ npm install
30+
```
31+
32+
3. Start the React development server with the following commands.
33+
34+
```
35+
$ npm start
36+
```
37+
38+
## Future of the project
39+
40+
Here are some of the changes to the project which I would like to incorporate into the project.
41+
42+
1. Allows users to enter graphs pictorially.
43+
2. Add other important graph algorithms to the application.
44+
3. Allow users to change the underlining algorithm and experiment with their own modifications so they are able to learn better.
45+
46+
## Contributing
47+
48+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
49+
50+
1. Fork the Project
51+
2. Create your Feature Branch (`git checkout -b feature/Ne wFeature`)
52+
3. Commit your Changes (`git commit -m 'Add some NewFeature'`)
53+
4. Push to the Branch (`git push origin feature/NewFeature`)
54+
5. [Open a Pull Request](https://github.com/abhayhk2001/Algorithm-Visualizer/pulls)
55+
56+
## License
57+
58+
Distributed under the MIT License. See `LICENSE` for more information.
59+
60+
## Contact
61+
62+
Abhay H Kashyap - [@AbhayHKashyap1](https://www.linkedin.com/in/abhay-h-kashyap/)
63+
64+
## Attributions
65+
166
Icons:
267
https://www.flaticon.com/authors/smashicons

0 commit comments

Comments
 (0)