Chesskit

<div align="center"> <a href="https://github.com/GuillaumeSD/Chesskit"> <img width="120" height="120" src="https://github.com/GuillaumeSD/Chesskit/blob/main/public/android-chrome-192x192.png" alt="Logo"> </a> <h3 align="center">Chesskit</h3> <p align="center"> The Ultimate Chess Web App <br /> <a href="https://chesskit.org/" target="_blank" rel="noopener noreferrer"><strong>chesskit.org</strong></a> <br /> <a href="https://discord.com/invite/Yr99abAcUr" target="_blank" rel="noopener noreferrer">Discord Server</a> · <a href="https://chesskit.notion.site/4cf7823836724432b71aa8932ba7d5bb" target="_blank" rel="noopener noreferrer">Features Backlog</a> </p> </div> <br />

Chesskit is an open-source chess website to play, view, analyze and review your chess games for free on any device with Stockfish !

Mission

Chesskit aims to offer all the chess related features it can, while being free and open-source. It is designed to be easy to use, fast, and reliable.

Features

• Load and review games from chess.com and lichess.org
• Analysis board with live engine evaluation, custom arrows, evaluation graph, ...
• Moves classification (Brilliant, Great, Good, Mistake, Blunder, ...)
• Chess960 and Puzzles support
• Play against Stockfish at any elo
• Store your games in your browser database

<img src="https://github.com/GuillaumeSD/Chesskit/blob/main/assets/showcase.png" />

Stack

Built with Next.js, React, Material UI, and TypeScript.

Deployed on AWS with AWS CDK, see it live here.

Running the app in dev mode

Using Node.js

[!IMPORTANT]
At least Node.js 22.11 is required.

Install the dependencies :

npm i

Run the development server :

npm run dev

Using Docker

Run the development server :

HOST_UID=$(id -u) HOST_GID=$(id -g) COMMAND=dev docker compose -f ./docker/docker-compose-dev.yml up

Open http://localhost:3000 in the browser to see the app running.

The app will automatically refresh on any source file change.

Lint

Run it with :

npm run lint

or with docker :

HOST_UID=$(id -u) HOST_GID=$(id -g) COMMAND=lint docker compose -f ./docker/docker-compose-dev.yml up

Contribute

See contributing for details on how to contribute to the project.

Deploy

To deploy the app, install AWS CLI and authenticate, then run :

npm run deploy

License

Chesskit is licensed under the GNU Affero General Public License 3. See copying for details.

Growing thanks to you ❤️

Self-hosting

To run the project locally in production mode, you can use docker and the following command :

docker compose -f ./docker/docker-compose-prod.yml up