https://github.com/wintrcat/freechess
WintrCat's Game Report ♟️
https://github.com/wintrcat/freechess
chess chess-engine
Last synced: 21 days ago
JSON representation
WintrCat's Game Report ♟️
- Host: GitHub
- URL: https://github.com/wintrcat/freechess
- Owner: WintrCat
- License: other
- Created: 2023-11-20T08:30:45.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-11T10:57:46.000Z (almost 2 years ago)
- Last Synced: 2024-06-11T12:17:53.905Z (almost 2 years ago)
- Topics: chess, chess-engine
- Language: TypeScript
- Homepage: https://chess.wintrcat.uk
- Size: 1.43 MB
- Stars: 434
- Watchers: 6
- Forks: 113
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# WintrCat's Game Report
**ABANDONED**
Freechess is an abandoned project and no longer maintained - it'll be kept up so the code is available to everyone.
The new website, [WintrChess](https://wintrchess.com/), is [open-source](https://github.com/wintrcat/wintrchess)!
Generate classifications for your Chess moves, for free.
Enter a game by its PGN or pick a game from your Chess.com / Lichess.org account and have it analysed so that you can see where your mistakes and brilliancies are.
## Running locally
### Prerequisites
- Node.js 20.x runtime or later.
- TypeScript package installed globally.
### Starting application
- Download the source code using `git clone` or download as ZIP.
- Open the root directory of the project in a terminal.
- Run `npm i` to install all of the necessary dependencies.
- Create a file called `.env` in the root directory of the project.
- Choose a port for the webserver by adding `PORT=` to the file.
- If you want to use a CAPTCHA:
- Add your client secret as `RECAPTCHA_SECRET=` to the .env file
- Open `src/public/pages/report/index.html`, find `data-sitekey` and replace the value with your reCAPTCHA public site key
- Run `npm start` to compile TypeScript and start the webserver.
### NPM Scripts
- `npm start` - Compiles TypeScript and starts the webserver.
- `npm run build` - Compiles TypeScript.
- `npm run test` - Generates reports from some sample evaluations for classification testing at `src/test/reports`.
## Running in Docker
### Prerequisites
- Docker installed on the server
### Build a Docker image
- Download the source code using `git clone` or download as ZIP.
- Open the root directory of the project in a terminal.
- Create a file called `.env` in the root directory of the project.
- If you want to use a CAPTCHA:
- Add your client secret as `RECAPTCHA_SECRET=` to the .env file
- Open `src/public/pages/report/index.html`, find `data-sitekey` and replace the value with your reCAPTCHA public site key
- Run `sudo docker build . -t freechess` to build the image
### Start a Docker container with the freechess image
- Run `sudo docker run -d -P freechess`
- If you wish to choose the port instead of Docker choosing one for you, replace `-P` with `-p :80`
## Attributions
@shirsakm - Classification icons
## Donate
I pay to keep my app running and free-to-use for everyone. Any donations are greatly appreciated ❤️
## Join the community
If you've found a bug in the website, have some cool suggestions or just want to have a chat, you can join my Discord!
