GrandLeague

GrandLeague

A cool modern football application to display matches in PremierLeague build with (Compose UI , ,Roomcoroutine ,retrofit ,MVVM Architecture , LiveData)

Explore the docs »

View Demo . Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Authors
• Acknowledgements

About The Project

I build the app to be offline first which loads data from API the inserts it in room database then the view fetches it from the database so the user will always see data which gives better user exprince

Here's how:

• Send request with retrofit to api to get data
• Insert the Fetched data to the Database
• Let the UI fetch the data from Room Database
• Now user always happy because the app always had data:smile:

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

A GrandLeague application build with\

• [Compose UI](Compose UI)
• coroutine
• retrofit
• MVVM
• DaggerHilt
• LiveData
• Room

Getting Started

Prerequisites

-Android Studio -Java SDK

Installation

1. Get a free API Key at https://www.football-data.org/

2. Clone the repo

git clone https://github.com/markoeltiger/GrandLeague.git

3. Enter your API in Constats.kt

    const val API_KEY = "here your api"

Usage

Clone The Project and open it in your android studio it will be helpful if you want to add some thing new

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

• Mark Saif - Software Engineer - Mark Saif - Build the project