Skip to content

Commit

Permalink
Add requirements and tech stack (#102)
Browse files Browse the repository at this point in the history
* add requirements

* minor change

* minor change

* list formatting

* make requirement collapsable

* minor change

* add emoji

* refactor requirements
  • Loading branch information
cp-sidhdhi-p authored Sep 19, 2024
1 parent b74ccea commit 827becd
Showing 1 changed file with 56 additions and 3 deletions.
59 changes: 56 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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" />
Expand Down Expand Up @@ -55,6 +55,59 @@ 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 ✅

<details>
<summary> Click to expand </summary>
<br>

**Khelo** requires the following to function properly:

**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? 🚀

Expand All @@ -75,12 +128,12 @@ 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
## 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" width=300></a>
<a href="https://canopas.com/contact"><img src="./cta/cta_btn.png" alt="Contact Canopas" width=300></a>


## Licence 📄
Expand Down

0 comments on commit 827becd

Please sign in to comment.