/Structurex

Javascript visualizer of algorithms and data structures.

Primary LanguageJavaScriptMIT LicenseMIT

Structurex

Javascript based Data Structure and Algorithm Visualizer

Website: https://akshitadixit.github.io/Structurex/

img

📑 Introduction

Algorithm Visualizer is a visual illustration of an algorithm’s operation, its perfomance on different kinds of inputs. Understanding algorithms with visulization is much easy. Structurex project aims to build such JavaScript based Data Structure and Algorithm visualizer.

Implementations include:

Sorting:

  • Bubble Sort
  • Selection Sort
  • Merge Sort
  • Insertion Sort
  • Quick Sort
  • Heap Sort

Searching:

  • Linear search
  • Binary Search

To-do/In-progress:

  • BST - search, traversals, creation
  • A* path finding
  • Djikstra's
  • A few graph algos (maybe)

Tech Stacks:

  • HTML
  • CSS
  • JAVASCRIPT

How to get started?

1.Add a star to this project for more updates on the project.

img

2. Fork the repository

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

img

For more details:

3.Clone the repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

img

Open your terminal/git bash/. Change the current working directory to the location where you want the cloned directory. Run the following commands:

  git init
  git clone  https://github.com/<your-account-username>/Structurex.git

<your-account-username> should be your github username.

For more details:

4.Create branch

Now create a branch using the git checkout command:

    git checkout -b your-new-branch-name

Branch name could be anything preferably related to your name or issue.

Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)

    git pull origin main

5.Make changes and commit them

Make the necessary changes on your local computer and save the file.

Add those changes to the branch you just created using the git add command:

  git add <file name>

or

    git add --all

Commit those changes using git commit command:

    git commit -m "message about what you have done"

6. Push changes to github

    git push origin <add-your-branch-name>

<add-your-branch-name> name of the branch you created earlier.

7.Submit your changes

Once you push the changes to your repo, the Compare & pull requestbutton will appear in GitHub.Click it and you will be taken to another screen.Then click Create pull request button.

For more details:

CONGRATS!! You have made a sucessful contribtion once your pull request (PR) gets merged.

👨🏻‍💻 Contribution Guidelines

  • Find an issue that you think you can solve. If you do not find any issue, try to create one by identifying problems in the project, or wanting to improve something, anything you wish.

  • Always ask for the issue to be assigned and only then start working on it.

  • Fork the repo. Clone it. Make changes in the code and push to your fork. Then create a pull request.

  • If you have problem with the above workflow, take help from mentors or search about the same on youtube and you will be able to do it.

Our valuable Contributors👩‍💻👨‍💻 :

License 📄

See the LICENSE file for details