gerin98/NewsCast

News App written in Kotlin to showcase Android best practices

A modern News App for Android written in Kotlin

NewsCast lets you find and and read articles you care about natively within the app. Browse from a wide assortment of categories and save interesting articles for later!

Table of Contents

1. Main Features
2. Api
3. Getting Started
4. Tech Stack
5. Even More Features
6. Credits
7. Author
8. License

Main Features 💡

Beatiful News Viewer

Read your news articles directly within the app. No redirects. No switching back and forth. Just you and your news.

Browse News from a variety of curated categories

Simply choose a news topic from the sidebar to browse the latest articles.

Save important news for later

We don't always have time to read through the whole article. Double tap to add an article to your favourites and come back to it later.

Search at your fingertips

Can't find what you're looking for? Search for keywords to find articles for practically any topic.

Api 📰

NewsCast is powered by Event Registry's api to search and provide relevant news articles.

Getting Started 🚀

Unfortunately, I can't afford to stay subscribed to Event Registry's API to keep this project running indefinitely. Don't worry though, you can sign up to obtain your own API key to run this project!

1. Sign up for an account on Event Registry. You can either use a Free Trial or subscribe to one of their Monthly Plans.
2. Install Android Studio.
3. Clone this repo.
   git clone https://github.com/gerin98/NewsCast.git
4. Open the project in Android Studio.
5. Create a file called gradle.properties if it doesn't already exist in your root project directory.
6. Add your API key for event registry into this file like this: API_KEY=YOUR_API_KEY Your file should look something like this:

android.useAndroidX=true
android.enableJetifier=true
API_KEY=YOUR_API_KEY

7. That's it! Sync and rebuild your project with Gradle and you're good to go!

Tech Stack 🛠️

• Language
  • Kotlin - First class and official programming language for Android development.
• Architecture
  • MVVM & Repository pattern - separate ui logic from business logic.
  • LiveData - an observable lifecycle-aware data holder class.
  • Coroutines - for asynchronous programming and more.
  • ViewBinding - easily write code that interacts with views.
• Dependency Injection
  • Koin - A pragmatic lightweight dependency injection framework.
• Network
  • Retrofit - A type-safe HTTP client for Android and Java.
  • OkHttp - an HTTP client that’s efficient by default.
  • Moshi - a modern JSON library for Android and Java.
• Database
  • Room - robust database access while harnessing the full power of SQLite.
• UI
  • Databinding - bind UI components in your layouts to data sources in your app.
  • Material Design - a visual language that synthesizes the classic principles of good design with the innovation of technology and science.
  • Icons - delightful, beautifully crafted symbols for common actions and items.
• Image loading
  • Glide - An image loading and caching library for Android focused on smooth scrolling.
• Logging
  • Timber - a logger with a small, extensible API which provides utility on top of Android's normal Log class.
• Testing
  • Robolectric - a framework that brings fast and reliable unit tests to Android.
  • Stetho - a sophisticated debug bridge for Android applications.

Even more features

Customize your news reader and read comfortably

NewsCast allows you to change your background colour and text size in Settings.

Manage all your favourites

Save your favourites and come back to them later. Favourites are available to read offline. When you're done, simply select them to remove them from your list.

Multiple language support

NewsCast provides news in 35 different languages.

Credits 📕

Icons made by Freepik from www.flaticon.com

Inspired by Fortnightly

Author ✏️

Gerin Amalaraj

License

MIT License

Copyright (c) 2020 Gerin Amalaraj

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.