Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
prrockzed authored Nov 17, 2024
1 parent 28982cd commit 80d7e2e
Showing 1 changed file with 148 additions and 32 deletions.
180 changes: 148 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,153 @@
# Chess Game in Reactjs
<div align="center">
<h1>chessed</h1>
<h4 align="center">
<p>Redefining the way chess is played – Four players, infinite strategies!</p>
</h4>

<p>
<a href="https://github.com/prrockzed/chessed/releases/latest">
<img alt="Latest release" src="https://img.shields.io/github/v/release/prrockzed/chessed?style=for-the-badge&logo=github&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41&include_prerelease&sort=semver" />
</a>
<a href="https://github.com/prrockzed/chessed/releases/latest">
<img alt="Release Date" src="https://img.shields.io/github/release-date/prrockzed/chessed?style=for-the-badge&logo=calendar&color=F2CDCD&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/prrockzed/chessed/pulse">
<img alt="Last commit" src="https://img.shields.io/github/last-commit/prrockzed/chessed?style=for-the-badge&logo=git&color=8bd5ca&logoColor=D9E0EE&labelColor=302D41"/>
</a>
<a href="https://github.com/prrockzed/chessed/stargazers">
<img alt="Stars" src="https://img.shields.io/github/stars/prrockzed/chessed?style=for-the-badge&logo=starship&color=c69ff5&logoColor=D9E0EE&labelColor=302D41" />
</a>
</br>
<a href="https://github.com/prrockzed/chessed/issues">
<img alt="Issues" src="https://img.shields.io/github/issues/prrockzed/chessed?style=for-the-badge&logo=bilibili&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/prrockzed/chessed/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/prrockzed/chessed?style=for-the-badge&logo=creativecommons&color=ee999f&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/prrockzed/chessed">
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/prrockzed/chessed?style=for-the-badge&logo=codesandbox&color=%23DDB6F2&label=SIZE&logoColor=D9E0EE&labelColor=302D41" />
</a>
</br>
<a href="https://github.com/prrockzed/chessed">
<img alt="Open Source" src="https://img.shields.io/badge/Free%20and%20Open%20Source-brightgreen?style=for-the-badge" />
</a>
</p>

</div>

### I am a chess fan who doesn't play good chess😅
---

## 📜 **Contents**

- [Description](#description)
- [Visuals](#visuals)
- [Installation for Local Development](#installation-for-local-development)
- [Releases](#releases)
- [Support](#support)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Acknowledgment](#acknowledgment)

---

## **Description**

**Chessed** is a one-of-a-kind platform to experience chess like never before. Built using **React** and **TypeScript**, it transforms the timeless two-player game into an engaging **four-player chess** experience.

This platform is for the curious, creative, and strategic minds who want to explore something more than the conventional chessboard. Whether you’re teaming up or playing solo, **Chessed** offers:
- Move suggestions, turn validation, and dynamic piece movement.
- Advanced mechanics like castling, pawn promotion, and check detection.
- Game termination features for checkmate scenarios.

**Chessed** is not just a game—it’s a journey into the evolving world of chess!

Chess is 'generally' played by two people. But online chess has revolutionized the way we play chess. New varients of chess is trending. Chess is no more a game played only by two people with the 64 squares and traditional 6 types of chess pieces. It is more. And online chess and specially chess.com has made it possible.<br>
<br>
Now even four players can simultaneously play chess, either by one way or the other, like a hand and brain chess. But we also have a chess set in which four player can play chess. Here I 'will be trying' to build a four player chess set with all the chess rules.<br>
<br>
Enjoy the game at: https://prrockzed.github.io/chessed

### Overview
Here the overview of the website:

<img width="370" alt="prrockzed 2023-07-12 at 11 39 29 PM" src="https://github.com/prrockzed/chessed/assets/97661506/c94a14bf-bad5-49da-987d-a46793325349">
<img width="370" alt="prrockzed 2023-07-12 at 11 39 53 PM" src="https://github.com/prrockzed/chessed/assets/97661506/0fea0ff4-8f6c-4556-826f-c1beb57a754b">
<img width="370" alt="prrockzed 2023-07-12 at 11 40 07 PM" src="https://github.com/prrockzed/chessed/assets/97661506/2d8ead16-2e24-47b8-b493-4b27c6391180">
<img width="370" alt="prrockzed 2023-07-12 at 11 40 28 PM" src="https://github.com/prrockzed/chessed/assets/97661506/05241131-dfd5-420c-bb9f-526928487c2e">


<br><br>
### 🛠️ For local development:
At first ensure that you have node and npm installed on your machine.<br>
Check it by running
```
node --version
npm --version
```
Now copy and paste the following command in your terminal and hit enter.
```
git clone https://github.com/prrockzed/chessed.git
cd chessed
npm install
npm run start
```

#### Was quite fun to make the game and even more fun to play it. Thanks chess.com for the inspiration.
---

## **Visuals**

Here’s a glimpse of what **Chessed** looks like:

<img width="370" alt="Screenshot 1" src="https://github.com/prrockzed/chessed/assets/97661506/c94a14bf-bad5-49da-987d-a46793325349">
<img width="370" alt="Screenshot 2" src="https://github.com/prrockzed/chessed/assets/97661506/0fea0ff4-8f6c-4556-826f-c1beb57a754b">
<img width="370" alt="Screenshot 3" src="https://github.com/prrockzed/chessed/assets/97661506/2d8ead16-2e24-47b8-b493-4b27c6391180">
<img width="370" alt="Screenshot 4" src="https://github.com/prrockzed/chessed/assets/97661506/05241131-dfd5-420c-bb9f-526928487c2e">

---

## **Installation for Local Development**

Follow these steps to set up **Chessed** on your local machine:

1. **Prerequisites:** Ensure you have Node.js and npm installed:
```bash
node --version
npm --version
```

2. **Clone and Setup:**
```bash
git clone https://github.com/prrockzed/chessed.git
cd chessed
npm install
npm run start
```

3. **Play and enjoy the game!**

---

## **Releases**

- **Current Release:** [v1.0.0](https://github.com/prrockzed/chessed/releases)
This is just the beginning. Stay tuned for more exciting updates and features as we transform **Chessed** into the ultimate chess platform.

---

## **Support**

If you like this project, please consider giving it a star ⭐ on GitHub – it helps the project grow and reach more people! Your support is much appreciated!
</br>

If you're interested in supporting the development of chessed further, please consider [sponsoring this project](https://github.com/sponsors/prrockzed). Your contributions will help cover expenses and enable more frequent updates and enhancements. Thank you for your support!

---

## **Roadmap**

**Vision:** Transform **Chessed** into a versatile chess platform hosting all kinds of chess variants, no matter how unique or experimental.

### Immediate Goals:
- Fix existing issues to enhance gameplay.
- Integrate the standard chess game into the platform.

### Long-Term Goals:
- Incorporate a variety of chess variants.
- Build a community-driven platform for chess enthusiasts to share and experiment.

**Rome wasn’t built in a day, and neither will this platform!**

---

## **Contributing**

Want to help make **Chessed** even better? Check out our [CONTRIBUTING.md](CONTRIBUTING.md) for details on how you can contribute to the project.

---

## **License, Security, and Code of Conduct**

- **License:** See [LICENSE](LICENSE).
- **Security Policy:** See [SECURITY.md](SECURITY.md).
- **Code of Conduct:** See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).

---

## **Acknowledgment**

Special thanks to [chess.com](https://chess.com) for the inspiration and revolutionizing online chess.

---

### **If you like this project, please leave a star on [GitHub](https://github.com/prrockzed/chessed)!**

0 comments on commit 80d7e2e

Please sign in to comment.