Skip to content

Latest commit

 

History

History
61 lines (45 loc) · 3.05 KB

README.md

File metadata and controls

61 lines (45 loc) · 3.05 KB
Raw

Gitter

NewsApp

An app that fetches latest news and headlines. It also allows the users to favourite their news. The user also has the option to choose the source of news. They can also search for any particular trending keyword. The following libraries were used in this project.

Also Room was used for adding offline support.

Steps of Installation

  1. Fork the github repo.
  2. Install the repo locally.
  3. Generate your own API key from newsapi.org.
  4. In your system level .gradle file create a file with the name gradle.properties and add the api key to it in the following manner :

MY_API_KEY = "you_api_key"

  1. Save the above file.
  2. Run the app.

Project Conventions

MVVM Architecture

The project follows the MVVM design pattern.
MVVM(Model–view–viewmodel) is one of the architectural patterns which enhances separation of concerns, it allows separating the user interface logic from the business (or the back-end) logic.

MVVM has mainly the following layers:

  • Model
    Model represents the data and business logic of the app. One of the recommended implementation strategies of this layer, is to expose its data through observables to be decoupled completely from ViewModel or any other observer.
  • ViewModel
    ViewModel interacts with model and also prepares observable(s) that can be observed by a View.
  • View
    Finally, the view role in this pattern is to observe a ViewModel observable to get data in order to update UI elements accordingly.

Roadmap

  • Adding different sections for Science, Technology and other types of news.
  • Improving the offline support.
  • Adding more filters
  • Adding unit testing

App Screenshots

License

(c) 2019 Sridhar Jajoo

This is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this app. If not, see https://www.gnu.org/licenses/.