From 74d95e64273bb7044cc3dd26ebbaf5366ad51119 Mon Sep 17 00:00:00 2001 From: cp-mayank-v Date: Tue, 1 Oct 2024 18:27:31 +0530 Subject: [PATCH] Update readme description --- README.md | 115 ++++++++++------------- cta/{app store.png => app_store.png} | Bin cta/{google play.png => google_play.png} | Bin 3 files changed, 51 insertions(+), 64 deletions(-) rename cta/{app store.png => app_store.png} (100%) rename cta/{google play.png => google_play.png} (100%) diff --git a/README.md b/README.md index b9160fb9..7180d13f 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,63 @@ -

+

-# Khelo- From Streets to Stadiums 🏏 -Khelo - an open-source ultimate companion for all things cricket! +# Khelo - From Streets to Stadiums 🏏 +**Your Ultimate Companion for Cricket Management** - + ## Overview -Welcome to Khelo, an open-source multi-platform app designed to cater to all your cricket needs, whether you're a cricket enthusiast, a team manager, or a player. With a wide array of features, our app simplifies the management of cricket teams, players, matches, and performance records. -It's like having a personal assistant for your team! +Welcome to Khelo, an open-source multi-platform app designed to cater to all your cricket needs, whether you're a cricket enthusiast, a team manager, or a player. With a wide array of features, our app simplifies the management of cricket teams, players, matches, and performance records. It's like having a personal assistant for your team! -Khelo is an open-source Flutter project written in Dart using Firestore database, Firebase authentication, and cloud firestore. This project uses Riverpod as state management library and it adapts clean architecture approach, organized into multiple modules. +Khelo is built using Flutter and Dart, leveraging Firestore for database management and Firebase for authentication. This project employs Riverpod as its state management solution, adhering to a clean architecture approach organized into multiple modules. ## Download App - + + ## Screenshots - - - + + + - - - - + + + +
Matches RecordTeams ListStart New MatchMatches RecordTeams ListStart New Match
- - - + + + - - - - + + + +
Score BoardCommentarySquadScore BoardCommentarySquad
- ## Features 🌟🌟 -- **Profile Management**: Create and manage profiles for players, coaches, and team managers effortlessly. -- **Team Creation**: Form your dream team by adding players and managing team compositions with ease. -- **Player Management**: Keep track of player details, including statistics, performance history, and personal information. -- **Match Data Recording**: Record detailed match data, including scores, wickets, runs, and other custom metrics, providing a comprehensive overview of each game. -- **Performance Tracking**: Monitor and analyze player performance over time, enabling informed decision-making and strategic planning. -- **Team Statistics**: Gain insights into team performance through comprehensive statistical analysis and reporting tools. -- **Toss Details**: Record toss details, including which team won the toss and their choice, enhancing match documentation and analysis. +- **Profile Management**: Effortlessly create and manage profiles for players, coaches, and team managers. +- **Team Creation**: Form your dream team by easily adding players and managing team compositions. +- **Player Management**: Keep track of player statistics, performance history, and personal information. +- **Match Data Recording**: Record detailed match data, providing a comprehensive overview of scores, wickets, and custom metrics. +- **Performance Tracking**: Analyze player performance over time for informed decision-making. +- **Team Statistics**: Gain insights into team performance through comprehensive statistical analysis and reporting. +- **Toss Details**: Document toss results, including winning teams and choices, for improved match analysis. - > **Note**: Khelo is currently in active development🚧, with plans to incorporate additional features shortly. +> **Note**: Khelo is currently in active development 🚧, with plans to introduce additional features soon! ## Requirements βœ…
- Click to expand + Click to expand
**Khelo** requires the following to function properly: @@ -79,6 +78,7 @@ Khelo is an open-source Flutter project written in Dart using Firestore database - **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. @@ -90,51 +90,38 @@ Khelo is an open-source Flutter project written in Dart using Firestore database ## 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 +Khelo leverages modern Flutter development technologies, adhering to industry best practices. Below is our current technology stack: +- **MVVM Architecture**: A design pattern that separates the user interface from business logic, enhancing testability. +- **Flutter**: A UI toolkit for building natively compiled applications. +- **Dart**: The programming language used to write Flutter apps. +- **Http & Dio**: Libraries for making network requests. +- **GoRouter**: A declarative routing package for Flutter. +- **RiverPod**: A state management solution that is simple and powerful. +- **Firebase Authentication**: For secure user authentication. +- **Firebase Firestore**: A scalable database for storing app data. +- **Cloud Functions**: To run backend code in response to events triggered by Firebase features. ## Contribution 🀝 -Khelo is an open-source project but currently, we are not accepting any contributions. - +Khelo is an open-source project, but we are not currently accepting contributions. However, we appreciate community feedback and suggestions for future improvements. ## 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. - +- **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). - +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! +Khelo is owned and maintained by the [Canopas team](https://canopas.com/). -Contact Canopas +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! +Contact Canopas ## Licence πŸ“„ diff --git a/cta/app store.png b/cta/app_store.png similarity index 100% rename from cta/app store.png rename to cta/app_store.png diff --git a/cta/google play.png b/cta/google_play.png similarity index 100% rename from cta/google play.png rename to cta/google_play.png