Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mahmood-anaam/news-reader-flutter
News Reader - A Flutter application to read, search, bookmark, and view news articles from various sources. Includes user authentication with Firebase.
https://github.com/mahmood-anaam/news-reader-flutter
authentication firebase flutter mobile-app news-api news-reader provider sharedpreferences sqflite webview
Last synced: about 2 months ago
JSON representation
News Reader - A Flutter application to read, search, bookmark, and view news articles from various sources. Includes user authentication with Firebase.
- Host: GitHub
- URL: https://github.com/mahmood-anaam/news-reader-flutter
- Owner: Mahmood-Anaam
- Created: 2024-06-25T19:47:48.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-11T01:16:30.000Z (6 months ago)
- Last Synced: 2024-08-22T22:28:29.047Z (6 months ago)
- Topics: authentication, firebase, flutter, mobile-app, news-api, news-reader, provider, sharedpreferences, sqflite, webview
- Language: Dart
- Homepage: https://github.com/Mahmood-Anaam/News-Reader-Flutter
- Size: 31.2 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# News Reader Application
News Reader is a Flutter-based mobile application that allows users to read news from various news channels and categories. Users can search for news, bookmark news, view news in a WebView, and manage their accounts with Firebase Authentication.
## Features
- User authentication (sign up, log in, log out, and password reset) using Firebase Authentication.
- Read news from various categories and channels.
- Search for news using the search bar.
- Bookmark news articles for later reading.
- View news articles in a WebView within the app.
## Screenshots
## Getting Started
To get started with the News Reader application, follow the instructions below.
### Prerequisites
- Flutter installed on your local machine.
- An API key from [News API](https://newsapi.org/). Create an account and obtain your API key.
- Firebase project set up with Authentication enabled.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/Mahmood-Anaam/News-Reader-Flutter.git
cd News-Reader-Flutter
```
2. Install dependencies:
```bash
flutter pub get
```
3. Create a `.env` file in the root directory and add your API key:
```env
API_KEY=your_api_key_here
```
4. Configure Firebase:
- Follow the [Firebase setup instructions](https://firebase.flutter.dev/docs/overview) for your platform (iOS/Android).
- Add your `google-services.json` (for Android) or `GoogleService-Info.plist` (for iOS) to the respective directory.
### Running the App
To run the app on an emulator or physical device, use the following command:
```bash
flutter run
```
## Libraries Used
- `provider: ^6.1.2`
- `path: ^1.8.3`
- `path_provider: ^2.1.3`
- `http: ^1.2.0`
- `collection: ^1.18.0`
- `shared_preferences: ^2.2.3`
- `webview_flutter: ^4.5.0`
- `firebase_core: ^2.27.0`
- `firebase_auth: ^4.17.8`
- `flutter_login: ^5.0.0`
- `sqflite: ^2.3.2`
- `flutter_dotenv: ^5.1.0`
## APK Deployment
The application is available for download in APK format for Android devices at the following link:
[Download APK](https://drive.google.com/drive/folders/1ESh6ONP5P5DzblpF1gDr-E5j3LBMWhgx?usp=sharing)
##