Chess Online ♟️

A real-time multiplayer chess game built with Node.js, Express, Socket.io, and Tailwind CSS. Play with friends using unique room codes instantly in your browser.

🚀 Features

• Real-time Gameplay: Powered by Socket.io for instantaneous move syncing.
• Private Rooms: Create or join games using unique codes.
• Responsive Design: Optimized for both desktop and mobile devices.
• Game Controls: Surrender, Play Again, and easy Room Code sharing.
• Timers: Interactive game clocks for both players.
• Modern UI: Sleek dark-mode aesthetic with smooth animations.

🛠️ Setup & Installation

Follow these steps to get the project running locally:

Prerequisites

• Node.js (v18.16.0 or higher recommended)
• Yarn or npm

Installation

1. Clone the repository:

   git clone https://github.com/khaizinam/chess-online.git
   cd chess-online

2. Install dependencies:

   yarn install

3. Configure environment variables:

   cp .env-sample .env

   Edit .env and provide your own values for PORT, GA_ID, etc.

Running the App

• Development Mode (with auto-reload):

  yarn watch

• Production Mode:

  yarn start

The server will start on the port specified in your .env file (default: 3037).

🌐 Deployment (Optional - Nginx)

If you are deploying to a production server using Nginx as a reverse proxy, you can use the provided nginx.conf as a template.

Setup Steps:

1. Create a new Nginx configuration file:

   sudo nano /etc/nginx/sites-available/chess-online

2. Copy the content from nginx.conf and paste it into the file. Adjust the server_name to your domain.
3. Enable the configuration:

   sudo ln -s /etc/nginx/sites-available/chess-online /etc/nginx/sites-enabled/

4. Test and restart Nginx:

   sudo nginx -t
   sudo systemctl restart nginx

Important

Make sure the proxy_pass port in Nginx matches the PORT defined in your .env file. The provided configuration includes necessary headers for WebSocket support (Upgrade, Connection).

📜 Game Rules

• Movement: Standard chess rules apply.
• Winning: Checkmate the opponent or win if they run out of time.
• Surrender: You can choose to surrender at any time to end the game immediately.
• Draw: The game ends in a draw if the board reaching a standard draw position.

🤝 Support Us

If you enjoy this project and would like to support its development, you can make a donation via the QR code below:

Thank you for your support! 💖

👤 Author

Developed and maintained by khaizinam.

• Website: khaizinam.io.vn
• GitHub: @khaizinam