Welcome to my chess application. As a chess enthusiast, I chose this project as my first major undertaking after learning React. While still in development, the application currently supports all piece movements, castling, en passant, and detects check and checkmate scenarios.
This section provides instructions on how to get a local copy up and running.
Before installing, make sure you have the following tools installed:
-
Node.js: The runtime environment for executing JavaScript code server-side. You can download it from Node.js official website.
-
npm (Node Package Manager): Comes with Node.js, but you can check if it's installed by running
npm -vin your terminal. If you need to update npm, run:npm install npm@latest -g
To get a local copy up and running follow these simple steps.
-
Clone the repository Begin by cloning the repository to your local machine:
git clone https://github.com/austin-cavanagh/chess.git
-
Navigate to the project directory Enter directory after cloning:
cd chess -
Install dependencies Install the necessary packages using npm:
npm install
-
Start the development server To start the Vite development server run:
npm run dev
-
Happy coding!
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Austin Cavanagh - GitHub - LinkedIn - austin.cavanagh.cs@gmail.com
Distributed under the MIT License. See LICENSE.txt for more information.