Skip to content
 
 

Repository files navigation

🎨 Vizit - Interactive Algorithm Visualizer

Learn algorithms visually through real-time, interactive animations

Next.js React TypeScript License PRs Welcome

🚀 Live Demo🐛 Report Bug✨ Request Feature


📖 Table of Contents


🌟 About

Vizit is an educational platform that brings algorithms to life through smooth, interactive visualizations. Perfect for students, educators, and anyone learning computer science fundamentals.

Why Vizit?

  • 🎯 Step-by-step execution with pause/play controls
  • 🎨 Beautiful animations with dark/light themes
  • 📊 Performance metrics tracked in real-time
  • 🧩 Multiple algorithms - sorting, data structures, graphs
  • 🎓 Educational focus - clear explanations and pseudocode

✨ Features

Available Visualizations

Sorting Algorithms

  • Bubble Sort
  • Merge Sort
  • Selection Sort

Math Algorithms

  • Fibonacci
  • GCD (Greatest Common Divisor)
  • Modular Arithmetic
  • Sieve of Eratosthenes
  • Prime Factorization

Data Structures

  • Stack
  • Queue
  • B-Tree

Graph Algorithms

  • Breadth-First Search (BFS)
  • Maze Generation

Visualization Controls

  • Step-by-step execution (play, pause, step, reset)
  • Speed control
  • Code highlighting
  • Custom input
  • Responsive design
  • Dark/Light themes

🚀 Quick Start

Prerequisites

  • Node.js 20.x or higher
  • npm, yarn, or pnpm

Installation

# Clone the repository
git clone https://github.com/masabinhok/vizit.git
cd vizit

# Install dependencies
npm install

# Run development server
npm run dev

# Open http://localhost:3000

Build for Production

npm run build
npm run start

🤝 Contributing

We welcome contributions from developers of all skill levels!

How to Contribute

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📚 Read our Contributing Guide for detailed instructions.

Good First Issues

Perfect for first-time contributors:

  • 🎨 Add new algorithms - Follow our Adding Algorithms Guide
  • 📚 Improve documentation - Add comments, fix typos, clarify instructions
  • 🐛 Fix bugs - Check our issue tracker
  • Enhance UI/UX - Improve animations, accessibility, or design
  • 🧪 Add tests - Help us improve code quality

Look for issues labeled: good-first-issue, help-wanted, hacktoberfest

Development Guidelines

  • Code Style: We use ESLint and Prettier - run npm run lint before committing
  • TypeScript: All code must be type-safe
  • Commits: Use conventional commits (e.g., feat:, fix:, docs:)
  • Testing: Test your changes thoroughly before submitting

📁 Project Structure

vizit/
├── app/
│   ├── algorithm/
│   │   ├── bfs/
│   │   ├── binary-search/
│   │   ├── btree/
│   │   ├── bubble-sort/
│   │   ├── fibonacci/
│   │   ├── gcd/
│   │   ├── maze-generation/
│   │   ├── prime-factorization/
│   │   └── ...
│   ├── layout.tsx
│   └── page.tsx
├── components/
│   ├── ui/
│   └── visualizers/
├── lib/
│   └── utils/
├── public/
├── docs/
│   ├── CONTRIBUTING.md
│   └── ADDING_ALGORITHMS.md
├── package.json
├── tsconfig.json
└── README.md

Key Architecture:

  • Each algorithm/data structure has its own dedicated page and logic file
  • Reusable, type-safe visualization components
  • Easy to extend – see Adding Algorithms Guide

📖 Documentation


🗺️ Roadmap

Coming Soon

  • Quick Sort and Merge Sort improvements
  • Binary Search visualization
  • Graph algorithms (DFS, Dijkstra)
  • Algorithm comparison mode
  • Mobile app support

See open issues for planned features and known bugs.


💬 Community


🏆 Contributors

Thanks to all our contributors! 🎉

Want to be featured here? Submit your first PR!


📄 License

This project is licensed under the MIT License - see LICENSE for details.


⭐ Show Your Support

If Vizit helps you learn algorithms:

  • ⭐ Star this repository
  • 🔀 Fork and contribute
  • 📢 Share with your learning community
  • 💬 Give us feedback

Made with 💙 by the open source community

⬆ Back to Top

About

Experience the beauty of algorithms through interactive visualizations, step-by-step breakdowns, and real-time animations.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages