Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shravzzv/odin-knights-travails-project
An implementation of finding the shortest path between a knight and its destination using a breadth-first search algorithm.
https://github.com/shravzzv/odin-knights-travails-project
algorithms breadth-first-search data-structures theodinproject
Last synced: about 1 month ago
JSON representation
An implementation of finding the shortest path between a knight and its destination using a breadth-first search algorithm.
- Host: GitHub
- URL: https://github.com/shravzzv/odin-knights-travails-project
- Owner: shravzzv
- License: mit
- Created: 2023-11-11T08:02:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-20T09:00:12.000Z (about 1 year ago)
- Last Synced: 2024-01-29T18:54:51.797Z (12 months ago)
- Topics: algorithms, breadth-first-search, data-structures, theodinproject
- Language: JavaScript
- Homepage: https://odin-knights-travails-project.vercel.app
- Size: 136 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Knights Travails
## Description
Knight's Travails is an interactive web application that demonstrates the ability of a knight on a chessboard to move from one square to any other square, given enough steps. This project serves as an implementation of finding the shortest path between a knight and its destination using a **breadth-first search algorithm**. Take a peek at [`pathfinder.js`](src/modules/pathFinder.js) file.
This project was completed as a part of The Odin Project. Here's the [project source](https://www.theodinproject.com/lessons/javascript-knights-travails).
[Look at the project demo here.](https://odin-knights-travails-project.vercel.app/)
## Features
- Interactive chessboard allowing users to move a knight and visualize the shortest path to a destination.
- Checkbox toggle to switch between moving the knight and the destination star.
- Dynamic highlighting of the path traveled by the knight.
## Technologies Used
[](https://skillicons.dev)
## Installation
To install the project, follow these steps:
```bash
git clone https://github.com/shravzzv/ODIN-Knights-Travails-project
cd ODIN-Knights-Travails-project
```
Open `index.html` in your browser or using live server.
## Usage
Explore the chessboard, click on squares to move the knight or set the destination star. Toggle between the knight and star movement using the provided toggle.
## How to Contribute
If you'd like to contribute, follow these steps:
1. Fork the repository on GitHub.
2. Clone your fork locally.
```bash
git clone https://github.com/shravzzv/ODIN-Knights-Travails-project
cd ODIN-Knights-Travails-project
```
3. Create a new branch for your feature or bug fix.
```bash
git checkout -b feature-or-bug-fix-name
```
4. Make your changes, commit them, and push them to your fork.
```bash
git add .
git commit -m "Your commit message here"
git push origin feature-or-bug-fix-name
```
5. Open a Pull Request on GitHub, comparing your branch to the original repository's `main` branch.
## Issue Tracker
Find a bug or want to request a new feature? Please let us know by submitting an issue.
- [Issue Tracker](https://github.com/shravzzv/ODIN-Knights-Travails-project/issues)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---