https://github.com/yannvanhalewyn/boyscout

A clojurescript rewrite of Pathfinding Visualizer
https://github.com/yannvanhalewyn/boyscout

algorithms clojure clojurescript functional-programming pathfinding shadow-cljs tailwindcss visualization

Last synced: about 2 months ago
JSON representation

A clojurescript rewrite of Pathfinding Visualizer

• Host: GitHub
• URL: https://github.com/yannvanhalewyn/boyscout
• Owner: yannvanhalewyn
• Created: 2019-10-14T19:00:05.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-26T13:30:59.000Z (almost 2 years ago)
• Last Synced: 2024-07-30T17:39:00.137Z (5 months ago)
• Topics: algorithms, clojure, clojurescript, functional-programming, pathfinding, shadow-cljs, tailwindcss, visualization
• Language: Clojure
• Homepage: https://yannvanhalewyn.github.io/boyscout
• Size: 1010 KB
• Stars: 11
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Boyscout ⛺

Boyscout is a Clojurescript rewrite of Clement Mihailescu's [Pathfinding Visualizer](https://github.com/clementmihailescu/Pathfinding-Visualizer/). All credit's for the idea and sexy animations sould go to him 🎓. Boyscout can visualize a couple of famous pathfinding algorithms for fun and educational purpouses.

View Boyscout in action on: [https://yannvanhalewyn.github.io/boyscout/](https://yannvanhalewyn.github.io/boyscout/) and after playing around a bit click on the Boyscout logo in the header for a hidden feature 😉.

This project has been built to practice algorithms, demonstrate the power of a declarative functional approach and most importantly to have some fun.

Some nice technical features to check out:

- A [board model](https://github.com/yannvanhalewyn/boyscout/blob/master/src/bs/board.cljs#L1) as a weighted bigraph

- An [algorithm abastraction](https://github.com/yannvanhalewyn/boyscout/blob/master/src/bs/algorithm.cljs#L1), think adapter pattern but not really. It's just some functions.

- A simple [animation system](https://github.com/yannvanhalewyn/boyscout/blob/master/src/bs/animation.cljs#L1) built with [core.async](https://clojure.github.io/core.async/) that can be stopped, rewinded and is open for more features (stepping feature? 🤔)

- Using clojure meta-data to [link straight to source](https://github.com/yannvanhalewyn/boyscout/blob/master/src/bs/algorithm.cljs#L8) in the UI

## Running

Clone the repo and the first time run:

    $ yarn install

    $ make css

Then to start and watch the test and dev build and start a nRepl server:

    $ make dev

And visit [localhost:8080](http://localhost:8080) to see the app, and [localhost:8081](http://localhost:8081) to se the test runner.

**Note:** you won't see a repl appear with this command. A nRepl server was started and you should connect to it with your favorite editor. If that's not an option you can run `make repl` to have a terminal repl. This won't build the test app though.

To watch the changes in css run:

    $ make css-watch

## Building

To build the project with all optimisations run:

    $ make build

And open the *index.html* file in the root of the project.