Skip to content

aryan4codes/RealChess

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

RealChess

RealChess is a full-stack real-time chess application that enables users to play chess online. The project is divided into two main parts:

  • Backend: Located in backend1, it handles game logic using chess.js and real-time communication using WebSockets provided by the ws library.
  • Frontend: Located in frontend, it is a React application built with Vite and styled with Tailwind CSS. It provides a responsive user interface with components like a chess board, play options, and landing screen.

Backend Setup

  1. Open a terminal in the backend1 directory:
    cd backend1
    npm install
  2. Build the TypeScript files:
    npx tsc
  3. Start the backend server (ensure you have Node.js installed):
    node dist/index.js
    The WebSocket server will run on port 8080 as defined in src/index.ts.

Frontend Setup

  1. Open a terminal in the frontend directory:
    cd frontend
    npm install
  2. Start the development server:
    npm run dev
  3. Open index.html in your browser or follow the URL provided by Vite.
    The frontend uses React with Vite, Tailwind CSS (configured in tailwind.config.js) and routing in App.tsx.

Technologies Used

  • Frontend: React, TypeScript, Vite, Tailwind CSS, Framer Motion, React Icons
  • Backend: Node.js, TypeScript, WebSockets (ws), chess.js

Scripts

Frontend (from frontend/package.json)

  • npm run dev - Starts the development server.
  • npm run build - Builds the frontend for production.
  • npm run lint - Lints the source code.

Backend (from backend1/package.json)

  • You can run custom scripts as needed. Currently, the backend package uses node for running the built code.

Contributing

Feel free to contribute by opening issues or submitting pull requests. If you have any questions, consult the documentation for Vite, React, or chess.js.

License

This project is open source. See the license file for details.

About

RealChess is a full-stack real-time chess application that enables users to play chess online.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published