Skip to content

Commit

Permalink
updated readme and added demo video
Browse files Browse the repository at this point in the history
  • Loading branch information
Harshit2756 committed Oct 10, 2024
1 parent 6222174 commit d85e043
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 58 deletions.
150 changes: 92 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,100 +1,134 @@
<div align="center" id="top">
<img src="https://github.com/Harshit2756/flutter_chess/blob/c46fdc4be95aede289f1e459d02621ffdbfaa45b/assets/logo/Chess_logo.png?raw=true" alt="Chess Game" width="200" height="200"/>

<a href="https://twitter.com/intent/follow?screen_name=Harshit2756"><img alt= "Twitter" src="https://img.shields.io/twitter/follow/Harshit2756">
</a>
<a href="https://www.linkedin.com/in/harshit-khandelwal-3a76631b9/">
<img alt="LinkedIn" src="https://img.shields.io/badge/LinkedIn-0077B5?logo=linkedin&logoColor=white&label=Harshit%20Khandelwal">
</a>
<br/>

<a href="https://twitter.com/intent/follow?screen_name=Harshit2756">
<img alt= "Twitter" src="https://img.shields.io/twitter/follow/Harshit2756?style=social">
</a>
<a href="https://www.linkedin.com/in/harshit-khandelwal-3a76631b9/">
<img alt="LinkedIn" src="https://img.shields.io/badge/LinkedIn-Harshit%20Khandelwal-blue?style=social&logo=linkedin">
</a>
</div>

<h1 align="center">Chess Game</h1>
<h1 align="center">🎮 Chess Game (Flutter)</h1>

<p align="center">
<img alt="GitHub top language" src="https://img.shields.io/github/languages/top/Harshit2756/flutter_chess">
<img alt="GitHub language count" src="https://img.shields.io/github/languages/count/Harshit2756/flutter_chess">
<img alt="Repository size" src="https://img.shields.io/github/repo-size/Harshit2756/flutter_chess">
<img alt="License" src="https://img.shields.io/github/license/Harshit2756/flutter_chess">
<!-- <img alt="GitHub issues" src="https://img.shields.io/github/issues/Harshit2756/flutter_chess"> -->
<!-- <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/Harshit2756/flutter_chess"> -->
<!-- <img alt="Github forks" src="https://img.shields.io/github/forks/Harshit2756/flutter_chess?color=56BEB8" /> -->
<!-- <img alt="Github stars" src="https://img.shields.io/github/stars/Harshit2756/flutter_chess?color=56BEB8" /> -->
</p>
<!-- ## Status
<h4 align="center">
🚧 StyleHub App 🚧
</h4> -->
<hr>

<p align="center">
<a href="#dart-about">About</a> &nbsp; | &nbsp;
<a href="#mobile_phone-see-it-in-action">See it in Action</a> &nbsp; | &nbsp;
<a href="#sparkles-features">Features</a> &nbsp; | &nbsp;
<a href="#white_check_mark-installation">Installation</a> &nbsp; | &nbsp;
<a href="#rocket-resources">Resources</a> &nbsp; | &nbsp;
<a href="https://github.com/Harshit2756" target="_blank">Author</a>
</p>
---

## :dart: About
## 📜 Table of Contents

This is a fully functional chess game built with Flutter, where users can play against each other.It provides an enjoyable and visually appealing experience across multiple platforms like Android, iOS.
- [📖 About](#book-about)
- [👀 See it in Action](#eyes-see-it-in-action)
- [📷 Screenshots](#camera-screenshots)
- [✨ Features](#sparkles-features)
- [✅ Installation](#white_check_mark-installation)
- [🚀 Resources](#rocket-resources)
- [👨‍💻 Author](https://github.com/Harshit2756)

## :mobile_phone: See it in action
---

| <a href="https://harshit2756.github.io/flutter_chess/" target="_blank"><img src="https://github.com/Harshit2756/Harshit2756/blob/main/Assets/Live_Preview_Trans.png?raw=true" width="90px"></a> | <a href=" " target="_blank"><img src="https://github.com/Harshit2756/Harshit2756/blob/main/Assets/Demo_Video_Trans.png?raw=true" width="90px"></a> | <a href="https://github.com/Harshit2756/flutter_chess/releases/download/v1.0.0/Chess_game_v1.0.0.apk" target="_blank"><img src="https://github.com/Harshit2756/Harshit2756/blob/main/Assets/Download_Apk_Trans.png?raw=true" width="90px"></a> | <a href="https://github.com/Harshit2756/flutter_chess/archive/refs/tags/v1.0.0.zip" target="_blank"><img src="https://github.com/Harshit2756/Harshit2756/blob/main/Assets/Source_Code_Trans.png?raw=true" width="90px"></a> |
| :--------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Live Preview | Demo Video | Download APK | Source Code |
## :book: About

<!-- ## Screenshots
![App Screenshot](https://tejasbadone.web.app/assets/img/portfolio/apps/eshop/eshop1-01.png)
**Chess Game** is a fully functional and visually appealing chess game built with Flutter. Play chess with another person in multiplayer mode and enjoy the seamless cross-platform experience on Android and iOS. The app offers a rich feature set with complete chess rules, move validation, and responsive design for a smooth gaming experience on any device.

![App Screenshot](https://tejasbadone.web.app/assets/img/portfolio/apps/eshop/eshop2-01.png)
---

![App Screenshot](https://tejasbadone.web.app/assets/img/portfolio/apps/eshop/eshop3-01.png) -->
## :eyes: See it in Action

## :sparkles: Features
| [![Live Preview](https://github.com/Harshit2756/Harshit2756/blob/main/Assets/Live_Preview_Trans.png?raw=true)](https://harshit2756.github.io/flutter_chess/) | [![Download APK](https://github.com/Harshit2756/Harshit2756/blob/main/Assets/Download_Apk_Trans.png?raw=true)](https://github.com/Harshit2756/flutter_chess/releases/download/v1.0.0/Chess_game_v1.0.0.apk) | [![Source Code](https://github.com/Harshit2756/Harshit2756/blob/main/Assets/Source_Code_Trans.png?raw=true)](https://github.com/Harshit2756/flutter_chess/archive/refs/tags/v1.0.0.zip) |
| :----------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| [**Live Preview**](https://harshit2756.github.io/flutter_chess/) | [**Download APK**](https://github.com/Harshit2756/flutter_chess/releases/download/v1.0.0/Chess_game_v1.0.0.apk) | [**Source Code**](https://github.com/Harshit2756/flutter_chess/archive/refs/tags/v1.0.0.zip) |

---

## 📺 Demo Video

![Demo Video](Screenshots/Demo_video.gif)

## :camera: Screenshots

<table width="100%">
<tbody>
<tr>
<td align="center"><img src="Screenshots/image_1.png?raw=true" width="200" alt="Screenshot 1"/></td>
<td align="center"><img src="Screenshots/image_2.png?raw=true" width="200" alt="Screenshot 2"/></td>
<td align="center"><img src="Screenshots/image_3.png?raw=true" width="200" alt="Screenshot 3"/></td>
</tr>
<tr>
<td align="center"><b>In-Game</b></td>
<td align="center"><b>Game Board</b></td>
<td align="center"><b>Move List</b></td>
</tr>
</tbody>
</table>

✔️ **Multiplayer Support** - Play with another person locally.\
✔️ **Move Validation** - Ensures valid chess moves are made according to the rules of chess.
---

## :sparkles: Features

✔️ **Multiplayer Mode**: Play locally with another player on the same device.\
♟️ **Move Validation**: Follows all official chess rules and validates every move.\
🏁 **Game End Detection**: Automatically detects checkmate, stalemate, and draw conditions.\
🔄 **Turn-Based Gameplay**: Alternates between black and white players seamlessly.\
📱 **Responsive Design**: Adaptable layout for different screen sizes, including mobile and tablet.

## :white_check_mark: Installation

To run this project, you need to have Flutter installed on your machine. If you don't have Flutter installed, you can follow the official Flutter installation guide [here](https://flutter.dev/docs/get-started/install).
To run this project locally, ensure Flutter is installed. You can follow the official guide [here](https://flutter.dev/docs/get-started/install).

**Requirements**:

- Flutter version `3.22.0`

- Flutter Version - 3.22.0
### Steps to Install:

Once you have Flutter installed, follow these steps to run the project:
1. **Clone the repository**:

1. Clone the repository:
```bash
git clone https://github.com/Harshit2756/flutter_chess.git
```

```bash
git clone https://github.com/Harshit2756/flutter_chess.git
```
2. **Navigate to the project directory**:

2. Navigate to the project directory:
```bash
cd flutter_chess
```

```bash
cd flutter_chess
```
3. **Install the dependencies**:

3. Install the dependencies:
```bash
flutter pub get
```

```bash
flutter pub get
```
4. **Run the app**:

4. Run the app:
```bash
flutter run
```

```bash
flutter run
```
---

## :rocket: Resources

The following Resources were used in this project:
The following resources were used to build this project:

- [Flutter Official Docs](https://flutter.dev/docs)
- [Flutter Community Medium](https://medium.com/flutter-community)
- [Stack Overflow: Flutter](https://stackoverflow.com/questions/tagged/flutter)
- [Icons](https://www.flaticon.com/)
- [Stack Overflow - Flutter](https://stackoverflow.com/questions/tagged/flutter)
- [Icons by Flaticon](https://www.flaticon.com/)

---

## 👨‍💻 Author

**Harshit Khandelwal**

- 🐦 [Twitter](https://twitter.com/Harshit2756)
- 💼 [LinkedIn](https://www.linkedin.com/in/harshit-khandelwal-3a76631b9/)
Binary file added Screenshots/Demo_video.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d85e043

Please sign in to comment.