Skip to content

Latest commit

 

History

History
82 lines (62 loc) · 2.26 KB

README.md

File metadata and controls

82 lines (62 loc) · 2.26 KB
Raw

Chess Room - Chess Puzzles & Games

Welcome to the Chess Room! This repository contains the source code for the Chess Room - Chess Puzzles & Games app, available on the App Store. The app is developed using Flutter.

Features

  • Interactive Chess Puzzles: Solve engaging chess puzzles of varying difficulty.
  • Play Chess Games: Compete against AI opponents or other players.
  • Learn Chess Tactics: Improve your skills with curated lessons and tutorials.
  • Customizable Chess Boards: Personalize the look and feel of your chessboard and pieces.
  • Performance Analysis: Track your progress and identify areas for improvement.

Installation

To run the project locally, follow these steps:

  1. Clone the repository: 
    git clone https://github.com/Apps-Bay-Limited/chess-room.git
  2. Navigate to the project directory: 
    cd chess-room
  3. Install dependencies: 
    flutter pub get
  4. Run the app on an emulator or a connected device: 
    flutter run

Requirements

  • Flutter: Version 3.0.0 or later
  • Dart: Version 2.17.0 or later

Environment Setup

  1. Install Flutter by following the official documentation.
  2. Set up an emulator or connect a physical device.
  3. Configure Firebase for authentication and analytics.

Folder Structure

lib/
├── models/           # Data models
├── views/            # App screens (UI)
├── logic/            # Business logic 
├── utils/            # Utility functions and 
pubspec.yaml          # Project dependencies

Contributing

Contributions are welcome! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch: 
    git checkout -b feature/your-feature-name
  3. Make your changes and commit them: 
    git commit -m "Add your feature description"
  4. Push your branch: 
    git push origin feature/your-feature-name
  5. Open a pull request and describe your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Happy coding! 👑♟️