README.md

Report Bug · Request Feature

Table of Contents

• About the Project
  • Features
  • Built With
• Getting Started
  • Prerequisites
  • Installation

• Contributing
• Contact
• Acknowledgements
• License

About The Project

Stay up-to-date on all your favourite topics with Fave. Search for anything and everything and get stories from multiple news sources.

• Get the latest news from around the world from over 80 news channels (CNN, NewYork Times, ESPN, Al-Jazeera, TechCrunch, Google news, Buzzfeed, Bloomberg ).
• Read Headlines, Full Articles, Save and Share stories with Family and Friends on all Social Media.
• Personalise your timeline by selecting your favourite news sources you can receive updates from and switch between Light and Dark Mode to suit your mood.

With Fave, you get an in-depth knowledge of global events and you don’t miss out on trending topics.

Features

• Explore any kind of news
• Save news to bookmark
• Read full article from news source
• Share news on social media

Built With

• Kotlin
• Dagger-Hilt
• Kotlin Coroutines
• NewsApi

Dependecies

• Jetpack
  • ViewModel
  • LiveData
  • Data Binding
  • Room
  • Paging-Library
• Dagger-Hilt
• Kotlin Coroutines
• Retrofit
• Glide
• OkHttp
• Gson
• Timber
• Junit4
• Mockito
• About Page

Getting Started

Prerequisites

• Android Studio v3.1.3 or higher
• Compile Sdk Version: 29
• Minimum sdk: 21

Installation

git clone https://github.com/breel93/Fave.git

or download zip and extract, open with android studio

Contributing

Any contributions will be greatly appreciated.

1. Fork the project
2. Create your feature branch (git checkout -b feature/AwesomeFeature)
3. Commit your changes (git commit -m 'Add some AwesomeFeature')
4. Push to the branch (git push origin feature/AwesomeFeature)
5. Open a pull request

Contact

• Kola Emiola - @kola_emi
• [email protected]

Acknowledgements