Skip to content

README.md

Latest commit

 

History

History
90 lines (55 loc) · 4.9 KB

README.md

File metadata and controls

90 lines (55 loc) · 4.9 KB
Raw

AlgoBuddy

Live Web Demo

CI & Quality Gates CodeQL Rust License: MIT GUI: eframe/egui Platform

AlgoBuddy is a cross-platform algorithm visualizer built in Rust using eframe and egui. It provides step-by-step interactive visualizations formatted according to the NeetCode 150 learning roadmap across 18 algorithmic categories. Available natively on Windows, macOS, and Linux, or live in your browser via WebAssembly. 147 Neetcode problems from the 18 categories are in the audit phase, and can be accessed anytime by enabling Developer Mode, while fully verified problems are available in the default public release.

ste

steps

Application Overview

Full-Screen NeetCode 150 Mastery Dashboard

Key Capabilities

  • 18 Core Categories (100% Complete NeetCode 150 Roadmap): Navigation structured into 18 algorithmic topic categories featuring all 150 problems: Arrays & Hashing, Two Pointers, Sliding Window, Stack, Binary Search, Linked List, Trees, Tries, Backtracking, Heap / Priority Queue, 1D Dynamic Programming, Bit Manipulation, Math & Geometry, Greedy, Intervals, Graphs, 2D Dynamic Programming, and Advanced Graphs.

  • Audit Gating System: Public Release Mode presents verified, fully audited problem visualizers (Contains Duplicate, Two Sum, and Valid Anagram), while Developer Mode (--dev / ?dev=true) unlocks all 150 implemented problem visualizers across 18 categories.

  • Deterministic State Engine: Models algorithm execution as discrete state snapshots, enabling forward and backward timeline scrubbing, variable speed playback (0.25x - 4.00x), and synchronized source line highlighting.

  • Interactive Visual Renderers: Features custom 2D DP memoization tables, matrix grid flood-fills, graph vector topology canvases, dual heap trees, and array trace renderers.

  • Theme & Accessibility System: Includes built-in dark/light themes alongside Protan/Deuteran Red-Green colorblind safe palettes.

  • Audit Gating System: Public Release Mode presents audited problem visualizers, while Developer Mode unlocks all 150 implemented problem visualizers for testing and contribution.

Quick Start

WebAssembly (WASM)

Try AlgoBuddy directly in your browser without installation:

Build from Source

Requirements: Rust 2021 Edition

# Clone repository
git clone https://github.com/Rowrow620/AlgoBuddy.git
cd AlgoBuddy

# Launch Public Release Mode
cargo run

# Launch Developer Mode (All 150 Problems Unlocked)
cargo run -- --dev

# Execute Automated Test Suite
cargo test

Architecture Overview

AlgoBuddy uses a deterministic snapshot model where generator functions in src/algorithms/ execute synchronously upfront to produce a timeline vector of discrete state snapshots (Vec<Step>). Execution logic is orchestrated in src/engine.rs, while the interactive GUI renders snapshots via cleanly decoupled src/ui/ component modules based on the active timeline scrubber index.

For detailed architecture diagrams, model definitions, and problem auditing workflows, see CONTRIBUTING.md.

Open Source & Community

We welcome community contributions! Please review our community guidelines:

License

Distributed under the MIT License. See LICENSE for details.