Algovi

A rebuild of a passion project I built with a friend in 2020.

View it here · Report Bug · Request Feature · View the original

Table of Contents

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

About The Project

Working professionally as a developer has taught me a great deal. However, in a professional setting, time is rarely a luxury—commitments must be honored, and deadlines must be met.

I wanted to take what I’ve learned and apply it to a personal project; something open-ended that I could build on freely, adding new features at my own pace.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

• Install node 20
  • fnm
  • nvm
  • direct
• Install pnpm

Installation

1. Clone the repo

   git clone https://github.com/basselalsayed/algo-visualiser-v2.git

2. Install NPM packages

   pnpm i

3. Development mode

   pnpm dev

4. Production mode

   pnpm preview

(back to top)

Roadmap

• MVP
  • Salvage algorithms from v1
• UI design
  • Responsive
• Pause visualisation mechanism via generators
• Store run info locally
  • Store run info in supabase
• Keyboard shortcuts/quick search
• Localisation (18 languages)
• Guided tour via shepherd.js
• Linting
  • Custom setup to prevent circular dependencies
• Adjustable animation speed
• Multiple shortest paths
• Testing
  • Vitest
  • Playwright
• CI - github actions
• Handle touch gestures
• Replace framer motion with native animations
  • Smoother reset UX
• Update viable algorithms to work diagonally

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

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".

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)

License

Distributed under the MIT license. See LICENSE.txt for more information.

(back to top)

Contact

Bassel Al-Sayed - [email protected]

Project Link: https://github.com/basselalsayed/algo-visualiser-v2

(back to top)

Acknowledgments

• Tom Walker
• https://github.com/othneildrew/Best-README-Template

(back to top)