Chess Mate is a web chess game made with React.js that allows players to play with their friends on the same browser and also saves the game progress in case the user wants to play later and it does not asks for registration.
This is only the frontend, you can access the backend repository in here.
If you wish to play the game you can click here.
- Node.js
- Npm
- Yarn - This is optional but in this readme I'll be using it on some CLI commands, you can use npm if you want.
These are some of the libraries that I used in this project
- Axios - Promise based HTTP client
- Prop-Types - Runtime type checking for React props.
- React.js - JavaScript library for building user interfaces
- React Toastify - Library for toast notifications
- Styled Components - Library that lets you write actual CSS inside JavaScript
All you need to do is run yarn at the root of the project in order to install the dependencies.
Then, add a .env file with a variable called REACT_APP_API_URL with the value of your API url. You can download the backend here and start the server yourself.
↑ back to: Table of contents
Run the command yarn start for a developer environment or yarn build to generate the production build.
↑ back to: Table of contents
The entire game logic is handled on the backend, the only thing the frontend is responsible, besides showing the content, is storing the browser_id in the local storage of the browser. That browser_id will be sent in every request through its header and will be used to identify the user's game.
Every time a request is successful, the frontend will get the response body containing the board state and overwrite the current state of the board.
↑ back to: Table of contents
This project is still under development and there are a lot of features needed to be done. If you wish to contribute, please take a moment to read the Contribution Guidelines.
↑ back to: Table of contents
This is a open-sourced software licensed under the MIT license.
↑ back to: Table of contents