/flutter_news_reader

A simple Flutter application that fetches the latest news articles from a remote API and presents them in an organized list format. Users can seamlessly read the full content of articles with just a tap. Stay updated with the latest news effortlessly!

Primary LanguageC++MIT LicenseMIT

News Reader Application

Description

A simple News app using News API.

Responsibilities

  • Read all news accross the globe from a variety of sources
  • Save news for offline reading
  • Simple and user-friendly interface

News Read UI

## Getting Started

Prerequisites

Ensure Flutter is installed on your machine. For installation instructions, refer to the official Flutter website.

Installation

Follow these steps to run the News Read Application:

  1. Clone this repository to your local machine:
git clone https://github.com/hredhayxz/flutter_news_reader.git
  1. Navigate to the project folder:
cd flutter_news_reader
  1. Install dependencies:
flutter pub get

How to Run

Connect your device or emulator and run the app using the following command:

flutter run

Used Packages

News Read integrates the following packages to enhance functionality:

  • http: ^1.1.0: Perform HTTP requests and interact with APIs.
  • shimmer: ^3.0.0: Shimmer effect when loading news in progress.
  • cached_network_image: ^3.3.0: For network image caching and showing.
  • flutter_riverpod: ^2.4.1: Flutter Riverpod for state management.
  • hive: ^2.2.3 & hive_flutter: ^1.1.0: As a local database for store news.
  • connectivity_plus: ^4.0.2: Use this for checking network connectivity.
  • flutter_launcher_icons: ^0.13.1: Simplify the generation of launcher icons on various platforms.

Challange I Faced

  • The first time I used Hive, it was complicated for me. I overcame this challenge by reading the documentation and having discussions with my close mates.
  • When I used Riverpod for the first time, it was also complicated for me. I overcame this challenge by reading the documentation, watching YouTube videos, and having discussions with my close mates.

Project Directory Structure

The News Read directory structure is organized as follows:

Contributors

Special Thanks

A heartfelt thanks to Moniruzzaman & Mujahedul Islam to share their knowledges with me & help me complete the project.

License

This project is licensed under the MIT License. Refer to the LICENSE file for details.