Giter Club home page Giter Club logo

algorithms-step-by-step's Introduction

Algorithms step-by-step

Streamlit App

A web app that automatically solves algorithms with step-by-step explanations.

The algorithms are implemented in Python and the explanations are written in Markdown. Additionally, for drawing the graphs, the Graphviz library is used.

The input for the algorithms is specified by the user in the web app. Also, the input can be generated randomly.

Algorithms

Setup

  1. Clone the repository:
git clone https://github.com/alexfdez1010/algorithms-step-by-step.git
  1. Install the dependencies:
pip install -r requirements.txt
  1. Run the app:
streamlit run app.py

Contributing

If you want to contribute to this project, you can do it in two ways:

  • Adding a new algorithm: you can add a new algorithm by creating a new file in the algorithms folder and adding the algorithm's description in the descriptions folder. You will also to configure the algorithm in the config.py file. You may want to take a look at the existing algorithms to see how they are implemented.
  • Improving the explanations: you can improve the explanations by editing the algorithms already implemented.

In either case, you can create a pull request and I will review it as soon as possible.

Bugs

If you find any bug, please open an issue in this repository and I will try to fix it as soon as possible. If you want to fix it yourself, you can also create a pull request. In any case, I will be very grateful for your help.

algorithms-step-by-step's People

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.