Skip to content

Commit cdc62bb

Browse files
committed
Update README.md
1 parent f07bdb9 commit cdc62bb

File tree

1 file changed

+61
-30
lines changed

1 file changed

+61
-30
lines changed

README.md

Lines changed: 61 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,78 @@
1-
# 🛤️ Unique Paths II Visualizer
1+
# 🧽 Unique Paths Visualizer
22

3-
An interactive web application that visualizes the **Unique Paths II** dynamic programming problem with obstacle support.
3+
A visual, interactive React application to explore **dynamic programming (DP)** and **shortest path algorithms**. Easily toggle between **Leetcode-style Unique Paths II** and **Dijkstra's shortest path**, build your own grid, and visualize the paths with animations.
44

5-
## ✨ Features
5+
### 🌐 Live Demo
66

7-
- **🖱️ Click & Drag**: Paint obstacles by clicking and dragging across the grid
8-
- **🎬 Path Animation**: Watch random valid paths being traced step-by-step
9-
- **📊 DP Values**: Toggle display of dynamic programming computation values
10-
- **📱 Responsive Design**: Works on desktop and mobile devices
11-
- **⚡ Real-time Updates**: Instant recalculation as you modify the grid
7+
> _https://greenmarioh.github.io/unique-paths-visualizer/_
128
13-
## 🚀 Demo
9+
---
10+
11+
## 📌 Features
1412

15-
Visit the live demo: [https://GreenMarioh.github.io/unique-paths-visualizer/](https://GreenMarioh.github.io/unique-paths-visualizer/)
13+
- 🧠 **Unique Paths II (DP)**: Based on [LeetCode - Unique Paths II](https://leetcode.com/problems/unique-paths-ii/description/), visualize the total number of paths avoiding obstacles.
14+
- 📏 **Shortest Path Mode**: Visualize the shortest path between two draggable points using **Dijkstra's Algorithm** with 8-directional movement.
15+
- 📆 Animated step-by-step path traversal
16+
- 🧱 Click-and-drag to create obstacles on the grid
17+
- 🔄 Adjustable grid size (up to 12×12)
18+
- 👁️ Option to show/hide DP table values
19+
- 💡 Clear, responsive UI with Tailwind CSS
1620

17-
## 🎮 How to Use
21+
---
1822

19-
1. **Grid Setup**: Adjust rows and columns using the input fields
20-
2. **Add Obstacles**: Click and drag to paint red obstacle cells
21-
3. **Remove Obstacles**: Drag over existing obstacles to erase them
22-
4. **Animate Path**: Click "Show Random Path" to see a path traced with smooth animation
23-
5. **View DP Values**: Toggle "Show Path Counts" to see the computed values
23+
## 🚀 Getting Started
2424

25-
## 🧮 Algorithm
25+
### 1. Clone the Repository
2626

27-
This visualizer demonstrates the **Unique Paths II** problem:
27+
```bash
28+
git clone https://github.com/GreenMarioh/unique-paths-visualizer.git
29+
cd unique-paths-visualizer
30+
```
2831

29-
- **Input**: An `m × n` grid with obstacles
30-
- **Goal**: Count unique paths from top-left to bottom-right
31-
- **Constraints**: Can only move right or down, obstacles block paths
32-
- **Solution**: Dynamic programming with obstacle handling
32+
### 2. Install Dependencies
3333

34-
## 🛠️ Technical Details
34+
```bash
35+
npm install
36+
# or
37+
yarn install
38+
```
3539

36-
- **Frontend**: React with Hooks
37-
- **Styling**: Tailwind CSS
38-
- **Animations**: CSS transitions with JavaScript timing
39-
- **Deployment**: GitHub Pages
40+
### 3. Start Development Server
4041

41-
## 📜 License
42+
```bash
43+
npm run dev
44+
# or
45+
yarn dev
46+
```
4247

43-
MIT License - feel free to use this code for educational purposes.
48+
Open [http://localhost:3000](http://localhost:3000) to view the app in your browser.
4449

4550
---
4651

47-
_Enhanced visualization of classic dynamic programming concept._
52+
## 🖼️ Screenshots
53+
54+
> _You can add screenshots or gifs here showcasing the DP mode, dragging Start/End, etc._
55+
56+
---
57+
58+
## 🛠️ Built With
59+
60+
- [React](https://reactjs.org/)
61+
- [TypeScript](https://www.typescriptlang.org/)
62+
- [Tailwind CSS](https://tailwindcss.com/)
63+
- [Vite](https://vitejs.dev/)
64+
65+
---
66+
67+
## 📄 License
68+
69+
MIT License. Feel free to fork and improve!
70+
71+
---
72+
73+
## 🙇‍♂️ Author
74+
75+
Created with ❤️ by [@GreenMarioh](https://github.com/GreenMarioh)
76+
77+
👉 View the source code:
78+
🔗 [https://github.com/GreenMarioh/unique-paths-visualizer](https://github.com/GreenMarioh/unique-paths-visualizer)

0 commit comments

Comments
 (0)