Skip to content

dotnize/chessu

Repository files navigation

chessu

ches.su Last commit

Yet another Chess web app.

chessu

  • play against other users in real-time
  • spectate and chat in ongoing games with other users
  • optional user accounts for tracking stats and game history
  • play solo against Stockfish (wip)
  • mobile-friendly
  • ... and more (view roadmap)

Built with Next.js 14, Tailwind CSS + daisyUI, react-chessboard, chess.js, Express.js, socket.io and PostgreSQL.

Development

Node.js 18 or newer is recommended.

This project is structured as a monorepo using pnpm workspaces, separated into three packages:

  • client - Next.js application for the front-end, deployed to ches.su via Vercel.
  • server - Node/Express.js application for the back-end, deployed to server.ches.su via Railway.
  • types - Shared type definitions required by the client and server.

Getting started

  1. Install pnpm.
  2. Install the necessary dependencies by running pnpm install in the root directory of the project.
  3. In the server directory, create a .env file for your PostgreSQL database. You can try ElephantSQL or Aiven for a free hosted database.
    PGHOST=db.example.com
    PGUSER=exampleuser
    PGPASSWORD=examplepassword
    PGDATABASE=chessu
  4. Run the development servers with pnpm dev.
    • To run the frontend and backend servers separately, use pnpm dev:client and pnpm dev:server, respectively.
  5. You can now access the frontend at http://localhost:3000 and the backend at http://localhost:3001.

Contributing

Please read our Contributing Guidelines before starting a pull request.

License

MIT