Skip to content

docs: fix incorrect README #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
beingmartinbmc merged 1 commit into from
Jun 12, 2026
Merged

docs: fix incorrect README #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

An interactive, browser-based playground for learning algorithms, data structures, and Git through animation. Every algorithm runs in the browser as pure TypeScript — no backend, no telemetry, no tracking.

**Live demo:** https://anksharma11.github.io/algorithm-visualizer/
**Live demo:** https://beingmartinbmc.github.io/algorithm-visualizer/

---

Expand All @@ -27,14 +27,17 @@ An interactive, browser-based playground for learning algorithms, data structure

## Quick start

Requires Node 20+.
Requires Node 22+.

```bash
npm install
npm run dev # Vite dev server with HMR
npm run lint # ESLint (strict; CI blocks on errors)
npm run build # tsc + vite build → docs/ for GitHub Pages
npm run preview # serve the production build locally
npm run dev # Vite dev server with HMR
npm run lint # ESLint (strict; CI blocks on errors)
npm test # run the Vitest suite once
npm run test:watch # Vitest in watch mode
npm run test:coverage # run tests with v8 coverage report
npm run build # tsc + vite build → docs/ for GitHub Pages
npm run preview # serve the production build locally
```

## Architecture
Expand All @@ -60,7 +63,7 @@ The pure-TS layer (`algorithms/` or `engine/`) returns arrays of `Step` objects

1. Create `src/features/myThing/`.
2. Write `algorithms/myThing.ts` — a pure function from input → `MyThingStep[]`.
3. Write `hooks/useMyThing.ts` — `useState` for the step pointer, `setTimeout` (or shared `useTones`) for playback.
3. Write `hooks/useMyThing.ts` — `useState` for the step pointer, `setTimeout` (or the shared `useSound` hook) for playback.
4. Write `components/MyThingCanvas.tsx` and `MyThingControls.tsx`.
5. Add a `MyThingPage.tsx` that composes the above.
6. Lazy-import the page in `src/App.tsx` and add a `<Route>`.
Expand Down Expand Up @@ -98,7 +101,7 @@ npm run build

- **TypeScript:** `tsc -b` passes with zero errors. Strict mode, `verbatimModuleSyntax`, `noUnusedLocals`, `noUnusedParameters`, `erasableSyntaxOnly`.
- **ESLint:** zero errors, zero warnings.
- **Tests:** none yet — pure step-builders in `engine/` and `algorithms/` are the natural targets when added.
- **Tests:** Vitest suite covering the pure step-builders in `algorithms/` (sorting, graph pathfinding, tree traversals, tree generation, linked-list algorithms, random-input helpers). CI runs `vitest run --coverage` and blocks merges below an 85% coverage gate.
- **Bundle:** initial route loads only landing-page + section-index chunks; feature pages are code-split.

## License
Expand Down
Loading