Skip to content

README.md

Latest commit

 

History

History
117 lines (87 loc) · 3.95 KB

README.md

File metadata and controls

117 lines (87 loc) · 3.95 KB

The game of chess

Table of Contents

Introduction

Welcome to The game of chess ! This is a chess game, built using JavaScript and React.

Stack

  • HTML5 CSS3
  • React.js
  • JavaScript
  • Babel
  • npm
  • GIT

Features

  • Play a classic game of chess.
  • Supports standard chess rules, including castling, en passant, and pawn promotion.
  • Interactive chessboard with functionality for moving pieces.
  • Real-time updating of game status, such as check, checkmate, and stalemate.
  • Highlight legal moves for the selected piece to assist players in making valid moves.
  • A move history display to review and analyze the sequence of moves during the game.
  • Support for standard notations (e.g., algebraic notation) for recording and sharing games.

These features make our chess project not only a traditional chess-playing experience but also a versatile and enjoyable platform for chess enthusiasts of all levels.

Demo

Demo Video

White won

Black promotion

White promotion

Installation

To run this project locally, follow these steps:

  1. Clone the repository
   git clone git@github.com:vvtelnov/chess-react.git
  1. Install dependencies
   npm install
  1. Start the development server
   npm start
  1. [Open the project in your browser]
   Open your web browser and go to http://localhost:3000/

Usage

Welcome to our chess game! Follow these steps to get started and make your moves:

  1. Launch the Game:

    • Open your web browser and navigate to the URL where the game is hosted.

  2. Start a New Game:

    • When you first open the game, the game has already been started.
    • You are supposed to play for two sides at the same time.

  3. Chessboard Interface:

    • The game interface consists of a standard 8x8 chessboard.
    • Pieces for each player are displayed on the board.

  4. Making a Move:

    • To make a move, click on the piece you want to move.
    • Valid move locations for that piece will be indicated by gray circles on the board.

  5. Capturing Pieces:

    • If your move involves capturing an opponent's piece, the capturing move will be indicated by red circles.

  6. Moving a Piece:

    • Click on the gray circle corresponding to the cell where you want to move your selected piece.
    • The piece will move to the chosen location if the move is legal.

  7. Check and Checkmate:

    • The game will check for checks and checkmates.
    • If your king is in check, it will be indicated.

  8. Move History:

    • The game keeps a record of all moves made during the game.
    • You can review the move history which is located at the top of your screen to analyze your game.

  9. End the Game:

    • The game will detect checkmate or a draw.
    • If you win or the game ends in a draw, it will be announced.

Enjoy your game of chess and have fun strategizing your moves!

Contributing

Contributions are welcome! If you'd like to contribute to [Project Name], please follow these steps:

  1. Fork the project repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them.
  4. Create a pull request and describe your changes.

License

open-source / MIT license.