Skip to content

Commit

Permalink
docs succesful now setting project
Browse files Browse the repository at this point in the history
  • Loading branch information
Harshit2756 committed Oct 8, 2024
1 parent af433f6 commit 407cfd2
Show file tree
Hide file tree
Showing 200 changed files with 6,425 additions and 100 deletions.
3 changes: 3 additions & 0 deletions .fvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"flutter": "3.24.3"
}
47 changes: 47 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Miscellaneous
*.class
*.log
*.pyc
*.swp
.DS_Store
.atom/
.buildlog/
.history
.svn/
migrate_working_dir/

# IntelliJ related
*.iml
*.ipr
*.iws
.idea/

# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/

# Flutter/Dart/Pub related
**/doc/api/
**/ios/Flutter/.last_build_id
.dart_tool/
.flutter-plugins
.flutter-plugins-dependencies
.packages
.pub-cache/
.pub/
/build/

# Symbolication related
app.*.symbols

# Obfuscation related
app.*.map.json

# Android Studio will place build artifacts here
/android/app/debug
/android/app/profile
/android/app/release

# FVM Version Cache
.fvm/
45 changes: 45 additions & 0 deletions .metadata
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# This file tracks properties of this Flutter project.
# Used by Flutter tool to assess capabilities and perform upgrades etc.
#
# This file should be version controlled and should not be manually edited.

version:
revision: "2663184aa79047d0a33a14a3b607954f8fdd8730"
channel: "stable"

project_type: app

# Tracks metadata for the flutter migrate command
migration:
platforms:
- platform: root
create_revision: 2663184aa79047d0a33a14a3b607954f8fdd8730
base_revision: 2663184aa79047d0a33a14a3b607954f8fdd8730
- platform: android
create_revision: 2663184aa79047d0a33a14a3b607954f8fdd8730
base_revision: 2663184aa79047d0a33a14a3b607954f8fdd8730
- platform: ios
create_revision: 2663184aa79047d0a33a14a3b607954f8fdd8730
base_revision: 2663184aa79047d0a33a14a3b607954f8fdd8730
- platform: linux
create_revision: 2663184aa79047d0a33a14a3b607954f8fdd8730
base_revision: 2663184aa79047d0a33a14a3b607954f8fdd8730
- platform: macos
create_revision: 2663184aa79047d0a33a14a3b607954f8fdd8730
base_revision: 2663184aa79047d0a33a14a3b607954f8fdd8730
- platform: web
create_revision: 2663184aa79047d0a33a14a3b607954f8fdd8730
base_revision: 2663184aa79047d0a33a14a3b607954f8fdd8730
- platform: windows
create_revision: 2663184aa79047d0a33a14a3b607954f8fdd8730
base_revision: 2663184aa79047d0a33a14a3b607954f8fdd8730

# User provided section

# List of Local paths (relative to this file) that should be
# ignored by the migrate tool.
#
# Files that are not part of the templates will be ignored by default.
unmanaged_files:
- 'lib/main.dart'
- 'ios/Runner.xcodeproj/project.pbxproj'
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"dart.flutterSdkPath": ".fvm/versions/3.22.0"
}
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Harshit Khandelwal

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
223 changes: 123 additions & 100 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,100 +1,123 @@
<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>
</div>

<h1 align="center">Chess Game</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

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.

## :mobile_phone: See it in action

| <a href=" " 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 |

<!-- ## Screenshots
![App Screenshot](https://tejasbadone.web.app/assets/img/portfolio/apps/eshop/eshop1-01.png)
![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) -->

## :sparkles: Features

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


## :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).

- Flutter Version - 3.22.0

Once you have Flutter installed, follow these steps to run the project:

1. Clone the repository:

```bash
git clone https://github.com/Harshit2756/flutter_chess.git
```

2. Navigate to the project directory:

```bash
cd flutter_chess
```

3. Install the dependencies:

```bash
flutter pub get
```

4. Run the app:

```bash
flutter run
```

## :rocket: Resources

The following Resources were used in 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/)
<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>

</div>

<h1 align="center">🎮 Chess Game</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)
- [✨ 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.

## :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 |

<!-- <hr>
### 📺 Demo Video
<video width="100%" height="auto" controls>
<source src="https://www.youtube.com/watch?v=Yw6u6YkTgQ4" type="video/mp4">
</video> -->

<hr>

### 📷 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>
</tr>
<tr>
<td width="1%"><img src=""/></td>
<td width="1%"><img src=""/></td>
<td width="1%"><img src=""/></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.

## :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).

- Flutter Version - 3.22.0

Once you have Flutter installed, follow these steps to run the project:

1. Clone the repository:

````bash
git clone https://github.com/Harshit2756/flutter_chess.git

2. Navigate to the project directory:

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

4. Run the app:

```bash
flutter run
```

## :rocket: Resources

The following Resources were used in 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/)
Binary file added Screenshots/image_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Screenshots/image_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Screenshots/image_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# This file configures the analyzer, which statically analyzes Dart code to
# check for errors, warnings, and lints.
#
# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
# invoked from the command line by running `flutter analyze`.

# The following line activates a set of recommended lints for Flutter apps,
# packages, and plugins designed to encourage good coding practices.
include: package:flutter_lints/flutter.yaml

linter:
# The lint rules applied to this project can be customized in the
# section below to disable rules from the `package:flutter_lints/flutter.yaml`
# included above or to enable additional rules. A list of all available lints
# and their documentation is published at https://dart.dev/lints.
#
# Instead of disabling a lint rule for the entire project in the
# section below, it can also be suppressed for a single line of code
# or a specific dart file by using the `// ignore: name_of_lint` and
# `// ignore_for_file: name_of_lint` syntax on the line or in the file
# producing the lint.
rules:
# avoid_print: false # Uncomment to disable the `avoid_print` rule
# prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule

# Additional information about this file can be found at
# https://dart.dev/guides/language/analysis-options
13 changes: 13 additions & 0 deletions android/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
gradle-wrapper.jar
/.gradle
/captures/
/gradlew
/gradlew.bat
/local.properties
GeneratedPluginRegistrant.java

# Remember to never publicly share your keystore.
# See https://flutter.dev/to/reference-keystore
key.properties
**/*.keystore
**/*.jks
Loading

0 comments on commit 407cfd2

Please sign in to comment.