Merge branch 'main' into sidhdhi/add-member-via-contacts

# Conflicts:
#	data/lib/api/user/user_models.dart
#	khelo/ios/Podfile.lock
#	khelo/ios/Runner.xcodeproj/project.pbxproj

README.md

@@ -1,6 +1,6 @@
 <p align="center"> <a href="https://canopas.com/contact"><img src="./cta/cta_banner.png"></a></p>
 
-# Khelo- From Streets to Stadiums🏏
+# Khelo- From Streets to Stadiums 🏏
 Khelo - an open-source ultimate companion for all things cricket!
 
 <img src="./screenshots/cover-image.png" />
@@ -55,13 +55,85 @@ Khelo is an open-source Flutter project written in Dart using Firestore database
 
  > **Note**: Khelo is currently in active development🚧, with plans to incorporate additional features shortly.
 
+## Requirements ✅
 
-## Created & Maintained By
-Khelo is owned and maintained by the Canopas team.
+<details>
+ <summary> Click to expand </summary>
+<br>
 
-You can follow them on Twitter at @canopassoftware for project updates and releases. If you are interested in building apps or designing products, please let us know. We'd love to hear from you!
+**Khelo** requires the following to function properly:
 
-<a href="https://canopas.com/contact"><img src="./cta/cta_btn.png" width=300></a>
+**Software:**
+
+- **Flutter**: [Download Flutter](https://flutter.dev/docs/get-started/install) (version: 3.24 or higher)
+- **Dart**: Installed as part of the Flutter SDK (version: 3.5 or higher)
+- **Firebase**: A free Google service offering various backend functionalities. (See [Firebase documentation](https://firebase.google.com/docs) for setup instructions)
+
+**Additional Requirements:**
+
+- A **Google account** to create a Firebase project.
+- An **active internet connection** for Firebase communication.
+
+**Platform-Specific Requirements:**
+
+- **Android (if targeting Android):**
+  - An Android device or emulator for development and testing.
+  - Android Studio (optional, but recommended) for development: [Download Android Studio](https://developer.android.com/studio)
+- **iOS (if targeting iOS):**
+  - A Mac computer with Xcode installed for development and testing.
+
+**Optional (for development and testing):**
+
+- **Firebase CLI**: Simplifies managing Firebase projects locally. (See [Firebase CLI documentation](https://firebase.google.com/docs/cli))
+
+</details>
+
+## Technologies Stack 📚
+
+Khelo utilizes the latest Flutter app development technologies and adheres to industry best
+practices. Below is the current technologies stack used in the development process:
+
+- MVVM Architecture
+- Flutter
+- Dart
+- Http
+- Dio
+- GoRouter
+- RiverPod
+- Firebase Authentication
+- Firebase Firestore
+- Cloud Functions
+
+
+## Contribution 🤝
+Khelo is an open-source project but currently, we are not accepting any contributions.
+
+
+## What's Coming Next? 🚀
+
+- **Tournament Feature**: Khelo will soon support tournament management, allowing users to organize
+   and track cricket tournaments with ease, right from the app.
+- **Live Streaming**: Watch live matches directly through Khelo as we introduce live streaming, making 
+  it easier to follow your favorite teams and matches in real time.
+- **Voice-Over Scoring**: Get an immersive cricket experience with voice-over scoring, providing 
+  live commentary and score updates as the game unfolds.
+- **Improve User Experience**: We're continuously working on improving the user experience, with
+  plans to incorporate additional features and enhancements shortly.
+
+
+## Feedback & Suggestions ✨
+
+We welcome and appreciate any suggestions you may have for improvement.
+
+For bugs, questions and discussions please use the [Github Issues](https://github.com/canopas/khelo/issues).
+
+
+## Credits 💻
+Khelo is owned and maintained by the [Canopas team](https://canopas.com/). 
+
+ You can follow them on Twitter at [@canopassoftware](https://twitter.com/canopassoftware) for project updates and releases. If you are interested in building apps or designing products, please let us know. We'd love to hear from you!
+
+<a href="https://canopas.com/contact"><img src="./cta/cta_btn.png" alt="Contact Canopas" width=300></a>
 
 
 ## Licence 📄

data/README.md

@@ -1,39 +1,14 @@
-<!--
-This README describes the package. If you publish this package to pub.dev,
-this README's contents appear on the landing page for your package.
+# data
 
-For information about how to write a good package README, see the guide for
-[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
+The `data` module serves as the data layer for the Khelo app. It handles all data-related operations, including fetching, storing, and managing data across the application. This module is designed to interact with various data sources, such as local databases and remote servers.
 
-For general information about developing packages, see the Dart guide for
-[creating packages](https://dart.dev/guides/libraries/create-library-packages)
-and the Flutter guide for
-[developing packages and plugins](https://flutter.dev/developing-packages).
--->
+## Key Features
 
-TODO: Put a short description of the package here that helps potential users
-know whether this package might be useful for them.
+- **Data Management:** Handles data operations such as CRUD (Create, Read, Update, Delete).
+- **Data Sources:** Interfaces with local and remote data sources.
+- **Error Handling:** Includes error handling and data validation.
 
-## Features
+### API
 
-TODO: List what your package can do. Maybe include images, gifs, or videos.
-
-## Getting started
-
-TODO: List prerequisites and provide or point to information on how to
-start using the package.
-
-## Usage
-
-TODO: Include short and useful examples for package users. Add longer examples
-to `/example` folder.
-
-```dart
-const like = 'sample';
-```
-
-## Additional information
-
-TODO: Tell users more about the package: where to find more information, how to
-contribute to the package, how to file issues, what response they can expect
-from the package authors, and more.
+- **Service:** Manages data operations and provides methods for data retrieval and updates.
+- **Api:** Defines data structures used within the app.

data/lib/api/user/user_models.dart

@@ -5,7 +5,6 @@ import 'dart:convert';
 import 'package:cloud_firestore/cloud_firestore.dart';
 import 'package:freezed_annotation/freezed_annotation.dart';
 
-
 part 'user_models.freezed.dart';
 
 part 'user_models.g.dart';

khelo/README.md

@@ -1,16 +1,14 @@
 # khelo
 
-A new Flutter project.
+The `khelo` module is the core UI component of the Khelo app. It contains the main Flutter application implementation and native integrations. This module handles the presentation layer and user interactions.
 
-## Getting Started
+## Key Features
 
-This project is a starting point for a Flutter application.
+- **User Interface:** Provides the complete user interface for the Khelo app.
+- **Native Integration:** Includes native code for platform-specific functionalities.
+- **Navigation:** Manages app navigation and routing.
 
-A few resources to get you started if this is your first Flutter project:
+### API
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
-
-For help getting started with Flutter development, view the
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.
+- **UI:** Contains all UI components used in the app.
+- **Components:** Contains reusable components.

khelo/ios/Podfile

@@ -51,9 +51,6 @@ post_install do |installer|
          ## dart: PermissionGroup.notification
         'PERMISSION_NOTIFICATIONS=1',
 
-        ## dart: PermissionGroup.contacts
-        'PERMISSION_CONTACTS=1',
-
       ]
 
     end