https://github.com/getrighhttt/newsfeed

An app that returns top news headlines, serchview, and room database.
https://github.com/getrighhttt/newsfeed

android clean-architecture coroutines glide hilt-android hilt-dependency-injection local mvvm mvvm-architecture navigation remote retrofit2 room searchview viewbinding viewmodel viewmodel-livedata webview

Last synced: about 2 months ago
JSON representation

An app that returns top news headlines, serchview, and room database.

• Host: GitHub
• URL: https://github.com/getrighhttt/newsfeed
• Owner: GetRighhttt
• Created: 2022-07-06T20:14:59.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-05-31T19:34:34.000Z (over 1 year ago)
• Last Synced: 2023-05-31T20:22:54.237Z (over 1 year ago)
• Topics: android, clean-architecture, coroutines, glide, hilt-android, hilt-dependency-injection, local, mvvm, mvvm-architecture, navigation, remote, retrofit2, room, searchview, viewbinding, viewmodel, viewmodel-livedata, webview
• Language: Kotlin
• Homepage:
• Size: 216 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## **NewsFeed**

## **Introduction**

This app is a clean code architected app.


It provides the top News headlines with a search functionality.


When an article is clicked, a user is routed to a webview of that article


that is read in straight from an API. A floating action button allows the user


to save the article to a local database(ROOM). A tab layout is used to swtich between


the current articles saved, and the latest articles listed. Users can swipe to delete


a saved article in the recycler view, and also undo that action by pressing "Undo" on


the Snackbar that displays.

## **Installation**

To install Project Title, follow these steps:

 

1. Have Android Studio downloaded.

2. Clone the repository into Android Studio: **`git clone: [email protected]:GetRighhttt/NewsFeed.git`**

## **Usage**

To use Project Title, follow these steps:

1. Open the project in Android Studio.

2. Modify the source code to fit your needs.

3. Build the project.

4. Start the project.

5. Use the project as desired.

## **Contributing**

If you'd like to contribute to Project Title, here are some guidelines:

 

1. Fork the repository.

2. Create a new branch for your changes.

3. Make your changes.

4. Write tests to cover your changes.

5. Run the tests to ensure they pass.

6. Commit your changes.

7. Push your changes to your forked repository.

8. Submit a pull request.

## **Demo**

#### Here is a list of all the features used in this application:

- Clean Code Architecture Package Structure

- SOLID principle

- DRY principle

- Retrofit2

- API(2 different functionalities.)

- Coroutines

- RoomDatabase

- Remote and Local DataSources

- Dagger-Hilt

- MVVM

- View Model

- Live Data

- Navigation - SafeArgs

- Glide

- Swipe to delete

- WebView

- SearchView

- Recycler View

- Recycler View Animations

- View Binding

- Bottom Navigation

- WebView



https://github.com/GetRighhttt/NewsFeed/assets/105057858/287fb82c-b6e7-40db-a53f-b95b0f0548c2

## **Contact**

If you have any questions or comments about Project Title, please contact **[email protected]**.