Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yazdanhaider authored Aug 27, 2024
1 parent aec7ec3 commit 36d28f8
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Turn-based Chess-like Game

This project implements a turn-based chess-like game with a server-client architecture, utilizing websockets for real-time communication and a web-based user interface.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

- Node.js
- npm (Node Package Manager)
- A modern web browser

### Installation

1. Clone the repository: https://github.com/yazdanhaider/Yazdan_Haider_21BCE10015
2. Navigate to the server directory: cd/Yazdan_Haider_21BCE10015/server
3. Install the required dependencies: npm i

### Running the Game

1. Start the server: npm start
2. Now backend run successfully
3. Now open the `index.html` file in your web browser using a live server.

## Game Rules

[Include the game rules you provided here]

## Built With

- Node.js - Server-side runtime
- Express - Web application framework
- WebSocket - Real-time communication protocol
- HTML/CSS/JavaScript - Front-end technologies

## Authors

- Your Name

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

0 comments on commit 36d28f8

Please sign in to comment.