Chess

This project is for the "DX and Clean Code: Enhancing Developer Experience through Quality Code TX00FK85-3001" course.

Online multiplayer chess with ephemeral games.

Getting Started

These instructions will help you get a copy of the project up and running on your local machine.

Prerequisites

Node.js (v18+): Download here.

Package Manager: pnpm (Recommended). Install via npm install -g pnpm. npm also works fine.

Installation

1. Clone the repository
2. In the terminal, navigate to the project root
3. Install dependencies: pnpm install or npm install
4. Add a .env file into packages/front/ with

VITE_SERVER_BASE_URL=http://localhost:3000
VITE_WS_BASE_URL=ws://localhost:3000

Running the game

To start the backend, in the project directory run: pnpm --filter backend dev

To start the frontend, in the project directory run: pnpm --filter front dev

Linting

Code style is enforced with eslint and prettier

The project can be linted with pnpm lint or npm run lint

Roadmap

• chess
• websocket server for online multiplayer
• web GUI

Terminology

• "FEN" (Forsyth-Edwards Notation) is used in the code to serialize/deserialize chess games.