https://github.com/mikolajszymczuk1/pathfinder

Editor for testing and visualize pathfinding algorithms
https://github.com/mikolajszymczuk1/pathfinder

astar-algorithm bfs dfs djikstra editor pathfinder pathfinding typescript vue3

Last synced: 4 days ago
JSON representation

Editor for testing and visualize pathfinding algorithms

• Host: GitHub
• URL: https://github.com/mikolajszymczuk1/pathfinder
• Owner: mikolajszymczuk1
• Created: 2023-06-27T23:24:34.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2023-10-16T22:00:47.000Z (about 1 year ago)
• Last Synced: 2024-04-28T06:27:43.500Z (7 months ago)
• Topics: astar-algorithm, bfs, dfs, djikstra, editor, pathfinder, pathfinding, typescript, vue3
• Language: TypeScript
• Homepage: https://fluffy-puppy-7fc168.netlify.app/
• Size: 25.5 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 45
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# PathFinder

PathFinder is a simulator environment that let you observe and play with different pathfinding algorithms.

## Editor in action

### Dark mode version

![](./docs/EditorInActionPreview2.gif)

### Light mode version

![](./docs//EditorInActionPreview.gif)

## Project stack:

| Tables | About |

|----------|------:|

| `Vue 3` | SPA Framework (Create app with components) |

| `Pinia` | State management library |

| `TypeScript` | Powerful upgrade for normal JavaScript |

| `VueUse` | Library with much useful hooks |

| `FontAwesome` | Library with nice svg icons |

| `Vitest` | For testing (Unit and Integrations tests) |

| `Cypress` | For E2E testing |

## Project Setup

```sh

npm install

```

### Compile and Hot-Reload for Development

```sh

npm run dev

```

### Type-Check, Compile and Minify for Production

```sh

npm run build

```

### Run Unit Tests with [Vitest](https://vitest.dev/)

```sh

npm run test:unit

```

### Run End-to-End Tests with [Cypress](https://www.cypress.io/)

```sh

npm run test:e2e:dev

```

This runs the end-to-end tests against the Vite development server.

It is much faster than the production build.

But it's still recommended to test the production build with `test:e2e` before deploying (e.g. in CI environments):

```sh

npm run build

npm run test:e2e

```

### Lint with [ESLint](https://eslint.org/)

```sh

npm run lint

```