updated readme and removed white screen bug

Harshit2756 · Oct 10, 2024 · 3eb96a7 · 3eb96a7
1 parent a152a03
commit 3eb96a7
Show file tree

Hide file tree

Showing 4 changed files with 80 additions and 70 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,3 +1,3 @@
 {
-  "dart.flutterSdkPath": ".fvm/versions/3.22.0"
+  "dart.flutterSdkPath": ".fvm/versions/3.24.3"
 }
diff --git a/README.md b/README.md
@@ -1,123 +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>
 
-<hr>
+---
 
 ## 📜 Table of Contents
 
 - [📖 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)
 
+---
+
 ## :book: About
 
-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.
+**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.
+
+---
 
 ## :eyes: 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="50px" ></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="50px"></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="50px"></a> |
-| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
-|                                                                                           Live Preview                                                                                           |                                                                                                                  Download APK                                                                                                                  |                                                                                                         Source Code                                                                                                         |
+| [![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)                                               |
+
+---
 
-<!-- <hr>
-### 📺 Demo Video
-<video width="100%" height="auto" controls>
-  <source src="https://www.youtube.com/watch?v=Yw6u6YkTgQ4" type="video/mp4">
-</video> -->
+## 📺 Demo Video
 
-<hr>
+![Demo Video](Screenshots/Demo_video.gif)
 
-### 📷 Screenshots
+## :camera: Screenshots
 
 <table width="100%">
   <tbody>
     <tr>
-      <td width="1%"><img src="Screenshots/image_1.png?raw=true"/></td>
-      <td width="1%"><img src="Screenshots/image_2.png?raw=true"/></td>
-       <td width="1%"><img src="Screenshots/image_3.png?raw=true"/></td>
-    </tr>
-    <!-- <tr>
-      <td width="1%"><img src=""/></td>
-      <td width="1%"><img src=""/></td>
-       <td width="1%"><img src=""/></td>
+      <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 width="1%"><img src=""/></td>
-      <td width="1%"><img src=""/></td>
-       <td width="1%"><img src=""/></td>
-    </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>
 
+---
+
 ## :sparkles: Features
 
-✔️ **Multiplayer Support** - Play with another person locally. \
-✔️ **Move Validation** - Ensures valid chess moves are made according to the rules of chess. \
-♟️ **Complete Chess Ruleset** - Includes all standard chess rules including castling, en passant, and pawn promotion. \
-🏁 **Game End Detection** - Automatically detects checkmate and stalemate conditions. \
-🔄 **Turn-Based Gameplay** - Alternates turns between white and black players. \
-📱 **Responsive Design** - Adapts to different screen sizes for optimal play on various devices.
+✔️ **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).
 
-- Flutter Version - 3.22.0
+**Requirements**:
 
-Once you have Flutter installed, follow these steps to run the project:
+- Flutter version `3.22.0`
 
-1. Clone the repository:
+### Steps to Install:
 
-````bash
-git clone https://github.com/Harshit2756/flutter_chess.git
+1. **Clone the repository**:
 
-2. Navigate to the project directory:
+   ```bash
+   git clone https://github.com/Harshit2756/flutter_chess.git
+   ```
 
-```bash
-cd flutter_chess
-````
+2. **Navigate to the project directory**:
 
-3. Install the dependencies:
+   ```bash
+   cd flutter_chess
+   ```
 
-```bash
-flutter pub get
-```
+3. **Install the dependencies**:
 
-4. Run the app:
+   ```bash
+   flutter pub get
+   ```
 
-```bash
-flutter run
-```
+4. **Run the app**:
+
+   ```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/)
diff --git a/web/index.html b/web/index.html
@@ -14,16 +14,15 @@
     This is a placeholder for base href that will be replaced by the value of
     the `--base-href` argument provided to `flutter build`.
   -->
-  <base href="$FLUTTER_BASE_HREF">
 
   <meta charset="UTF-8">
   <meta content="IE=Edge" http-equiv="X-UA-Compatible">
-  <meta name="description" content="A new Flutter project.">
+  <meta name="description" content="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.">
 
   <!-- iOS meta tags & icons -->
   <meta name="apple-mobile-web-app-capable" content="yes">
   <meta name="apple-mobile-web-app-status-bar-style" content="black">
-  <meta name="apple-mobile-web-app-title" content="chess">
+  <meta name="apple-mobile-web-app-title" content="Chess">
   <link rel="apple-touch-icon" href="icons/Icon-192.png">
 
   <!-- Favicon -->

diff --git a/web/manifest.json b/web/manifest.json
@@ -1,11 +1,11 @@
 {
-    "name": "chess",
-    "short_name": "chess",
+    "name": "Chess",
+    "short_name": "Chess",
     "start_url": ".",
     "display": "standalone",
     "background_color": "#0175C2",
     "theme_color": "#0175C2",
-    "description": "A new Flutter project.",
+    "description": "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.",
     "orientation": "portrait-primary",
     "prefer_related_applications": false,
     "icons": [
@@ -32,4 +32,4 @@
             "purpose": "maskable"
         }
     ]
-}
+}