The Chess PGN Viewer is a web application that allows users to paste PGN (Portable Game Notation) text of a chess game and view the game moves on an interactive chessboard. This tool is useful for chess enthusiasts who want to review and analyze their games.
- Paste PGN text containing chess moves.
- Display an interactive chessboard to review the game.
- Navigate through the moves to analyze the game step-by-step.
- Simple and intuitive user interface.
To set up the project locally, follow these steps:
-
Clone the repository:
git clone https://github.com/Vanshpanchal/Chess-Notation-Viewer.git
-
Navigate to the project directory:
cd Chess-Notation-Viewer -
Install the dependencies:
Make sure you have Node.js installed. Then run:
npm install
-
Start the development server:
npm start
The application should now be running on
http://localhost:3000.
Once the server is running, open your browser and navigate to http://localhost:3000.
- Copy the PGN text from your source (e.g., a chess website, document, etc.).
- Paste the PGN text into the designated input area in the application.
- The pasted game will be displayed on the chessboard.
- Use the navigation controls to move through the game step-by-step.
- You can analyze the game by stepping through each move.
- The notation of each move is displayed alongside the chessboard.
Contributions are welcome! If you would like to contribute, please fork the repository and create a pull request with your changes. For major changes, please open an issue first to discuss what you would like to change.
- 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