Skip to content

TheGonzalezDesigns/gash

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

⚡️ GASH: Real-time Pathfinding Visualization

Banner Image

Build Status WASM Three.js Three.js

GASH: Test your crypto arbitrage algorithms in real-time with Rust and WebAssembly. Fast, portable, beautiful, and customizable. Check it out!


❓ Why?

Inspired by the need to test different pathfinding algorithms for the sake of crypto arbitrage, this repo was designed to allow FinTech and Crypto Devs alike, to prove the effectiveness of their custom algorithms in real-time. As your custom algorithm finds an arbitrage opportunity, the path to reach this opportunity is reflected in the browser. Given that finance is extremely competitive this repo was build with rust and wasm for extreme speed. You can of course fork the repo and switch to any other low level language if this is not enough. We use bun to compile the typescript-wasm imports in a tiny file that should load instantly onto your browser for maximum portability. This is all in development but you can expect regular updates as I improve this repo to fit my needs.


🌟 Features

  • 3D Visualization: Experience the arbitrage pathfinding algorithm unfold in a 3D grid.
  • WebAssembly: Harnessing the power of Rust compiled to WebAssembly for swift pathfinding.
  • Dynamic Grids: Spawn random room grids with distinct locks to challenge the pathfinding algorithm.

🛠️ Installation & Set Up

  1. Clone the repository
git clone https://github.com/TheGonzalezDesigns/gash.git
  1. Navigate to the directory
cd gash
  1. Run the project using Docker (Ensure you have Docker and Docker Compose installed)
docker-compose up

🕹️ Usage

After initiating the project, head to http://localhost:9876 in your browser. Watch your pathfinder in action.


🔍 How It Works

  1. Rooms & Doors: Each cell signifies a room equipped with an entry and an exit door, both bearing unique lock statuses.
  2. Pathfinding Algorithm: An in-house algorithm is employed to delineate a path from the start to the destination room.
  3. Visualization: Observe the algorithm in action as it spotlights the path in a real-time simulation.

🤝 Contributing

Your input is invaluable! We welcome contributions, queries, and feature proposals. Check out CONTRIBUTING.md for more.


📜 License

This project follows the MIT licensing protocol.


💌 Contact