Skip to content

This project offers an interactive React Native app with a C++ backend for visualizing and understanding shortest path algorithms. It aids education, algorithm testing, and practical routing scenarios, catering to students, educators, researchers, and professionals.

License

Notifications You must be signed in to change notification settings

ThapaVinay/GraphPathGuru

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to Graph Path Guru ! 📉 Make Graphs, anywhere.


📚 Table of Contents
  1. 👋 Introduction
  2. 🌐 About The Project
  3. 🧰 Tech Stack Used
  4. 🌟 Features
  5. 🚀 Usage
  6. 📁 Folder Format
  7. 🤝 Contributing
  8. 🏆 Contributors
  9. 📝 License

👋 Introduction

Graphpathguru is a user-friendly application meticulously crafted to offer individuals an accessible platform for in-depth exploration and understanding of algorithmic operations, all presented in a visually intuitive manner. The platform boasts a diverse array of algorithms, providing users with the flexibility to choose and engage with various computational processes. Additionally, Graphpathguru includes a host of convenient features, including the ability to save generated graphs for future reference and a streamlined sharing function for uniform graph distribution. This comprehensive tool aims to empower users with a seamless and enriching experience in algorithmic analysis, combining ease of use with robust functionality.


🌐 About The Project

Graphpathguru is a application focused on making graph algorithms more accessible and understandable for users. By providing a visually intuitive platform, users can explore and comprehend the operations of various algorithms.

(Back to top)


🧰 Tech Stack Used

react javascript tailwind mui mongo mui cpp

(Back to top)

🌟 Features

  1. Real-Time Updates: As users interact with the application, they may see real-time updates to the graph and algorithm outcomes, providing instant feedback.

  2. Visualization: The tool likely provides graphical representations of graphs and the outcomes of algorithms. Visualizations can help users better understand how algorithms traverse and manipulate graph structures.

  3. Algorithm Variety: Graphpathguru offers a range of graph algorithms for users to choose from. This could include well-known algorithms like Dijkstra's algorithm, breadth-first search, depth-first search, and more.

  4. User-Friendly Interface: The application likely has a user-friendly interface that makes it easy for users, even those without a deep understanding of graph algorithms, to navigate and interact with the tool.

  5. Educational Purpose: The tool could be designed with an educational focus, helping users learn about graph algorithms through hands-on exploration rather than relying solely on theoretical explanations.

  6. Open Source: Contribute to the project, adapt it for your needs, or integrate it into your applications.


🐺 Usage

Graphpathguru stands as a meticulously crafted, user-friendly application designed to provide an accessible platform for in-depth exploration and comprehension of algorithmic operations. Follow these simple steps to visualize your graphs:

  1. Go to Playground: Elevate your exploration experience by launching the application in the dynamic "Playground" state, setting the stage for an engaging interactive journey.
  2. Add your nodes and edges: Thoughtfully select nodes and your preferred application from the dropdown menu, establishing connections through edges. This visual representation brings to life intricate relationships within your chosen system.
  3. Add weights to your edges: Deepen your analysis by assigning weights to edges, capturing nuanced connections. Initiate the visualization process to witness the real-time flow and impact of the selected algorithm on associated nodes.
  4. Visualize: Once the graph is generated, click the "Visualize" button to look over how the graph wil behave over the selected algorithm.
  5. Result: Upon completion, the application provides detailed findings based on the utilized algorithm, enriching your understanding of complex systems.

The application is offering a visually intuitive interface, the platform encompasses a diverse array of algorithms, granting users the flexibility to engage with various computational processes.

(Back to top)


📁 Folder Format

GraphPathGuru/
|-- client/
|   |-- public/
|   |-- src/
|   |-- .gitignore/
|   |-- node_modules/
|   |-- package.json
|   |-- package-lock.json
|   |-- tailwind.config.js
|-- server/
|   |-- C++ source files
|   |-- index.js
|   |-- db.js
|   |-- routes/
|   |-- models/
|   |-- middleware/
|-- ...

🤝🏼 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. You are free to modify it whatever way you want. Just clone and enjoy 🚀. Please make sure to update tests as appropriate.

Instructions over how to Contribute.

Step 1. Install Git/ Github in your system. Fork the repository: This step creates a copy of the original repository under your GitHub account.

git clone https://github.com/H-SM/GraphPathGuru.git
cd GraphPathGuru

Step 2 . Create a new branch: It's recommended to create a new branch for your contribution. This helps keep your changes separate from the main branch.

git checkout -b my-branch

Step 3. Make and commit your changes: Write your code or make the necessary modifications to the files in the repository. Once you're done, commit your changes with a meaningful message describing the changes you made.

git add .
git commit -m "Add my contribution"

Step 4. Sync with the original repository: Keep your forked repository in sync with the original repository to incorporate any recent changes made by other contributors.

git remote add upstream https://github.com/H-SM/GraphPathGuru.git
git fetch upstream
git merge upstream/main

Step 5. Push your changes and create a pull request: Push your branch with the committed changes to your forked repository. Then, create a pull request to propose your changes to the original repository.

git push origin my-branch

After pushing your changes, you can visit the original repository's page on GitHub or the respective hosting platform. From there, you can create a pull request by following the prompts.

Note that these commands assume you're using HTTPS to clone and push to the repository. If you have set up SSH keys, you can use the SSH URL instead for cloning and pushing.

(Back to top)


🏆 Contributors


📝 License

The project is licensed under the MIT License.

(Back to top)

© 2023 GraphPathGuru. All rights reserved.

About

This project offers an interactive React Native app with a C++ backend for visualizing and understanding shortest path algorithms. It aids education, algorithm testing, and practical routing scenarios, catering to students, educators, researchers, and professionals.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 79.6%
  • C++ 17.8%
  • Rust 1.6%
  • Other 1.0%