johan-stph/algorithm-visualizer

Algorithm Visualizer

This project aims to provide a visual representation of various algorithms. And adds the possibility to solve them.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• ]
• ]
• ]
• ]
• ]

(back to top)

Getting Started

Follow this guide to get a local copy up and running.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• docker

  https://docs.docker.com/get-docker/

• Java 17

  https://www.oracle.com/java/technologies/downloads/#java17

Installation

1. Clone the repo

   git clone https://github.com/johan-stph/algorithm-visualizer.git

2. Package the Spring Boot Application

   cd ..
   cd api
   mvn clean package

3. Build and start the Docker Image

   cd ..
   docker-compose up

4. Go to Localhost and enjoy the application

   http://localhost:3000/

(back to top)

Roadmap

• K-Means Algorithm
• Simplex Algorithm
• Dijkstra Algorithm

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Johannes Stephan - johannes.uni.kit@gmail.com

Project Link: https://github.com/johan-stph/algorithm-visualizer

(back to top)

Acknowledgments

(back to top)