/Big-News-App

Big News: Your go-to app for browsing and searching news articles, built with Kotlin and Jetpack Compose.

Primary LanguageKotlinMIT LicenseMIT

gfi

Big News

Big News is a news app that helps you stay updated with the latest news. It is built using Jetpack Compose and Kotlin. The app uses several libraries to make the experience smooth and enjoyable. You can browse news by different categories or search for specific news articles.

Features

  • Browse News by Category: You can view news in different categories like:
    • Top Headlines
    • Tech
    • Sports
    • Business
    • Entertainment
    • Gaming
    • Health
    • Science
  • Search News: You can search for any news article.
  • User Interface: The app has a smooth and interactive user interface built with Jetpack Compose.
  • Interactive Elements: The app includes various interactive elements such as Alert Dialogs, Modal Bottom Sheets, and a Modal Navigation Drawer.
  • Shimmer Effect: Utilizes the shimmer effect to enhance the loading experience for news tiles.
Big.News.App.Video.mp4

Technologies Used

Languages and Frameworks

  • Kotlin: The main programming language used to build the app.
  • Jetpack Compose: Used for creating the user interface.

Architecture

  • MVVM (Model-View-ViewModel): The app follows the MVVM architecture pattern, which separates the presentation layer from the business logic and data model.

Libraries

  • Retrofit: Used for making network requests and fetching news data from the internet.
  • Navigation: Used for moving between different screens in the app.
  • Coil: Used for loading images.
  • Swipe Refresh: Used to refresh the news feed by pulling down.

API

  • NewsAPI: The app fetches news data from NewsAPI. You will need to sign up and obtain an API key to use the service.

Upcoming Features

We are continuously working on improving Big News. Here are some upcoming features you can look forward to:

  • Dynamic Theme: Support for light and dark themes that change based on user preference or system settings.
  • Filter News by Country: Option to filter news articles based on the user's country or region.
  • Zoom News Image: Ability to zoom in on news images for a closer look.
  • Download News Image: Option to download news images to your device.
  • Fix Bugs: Ongoing efforts to identify and fix bugs to improve the app's performance and stability.

Getting Started

Installation

  1. Clone the Repository:

    git clone https://github.com/Muhammad-Noman59/Big-News-App.git
  2. Open in Android Studio: Open the project in Android Studio.

  3. Sync Gradle: Sync the project with Gradle files.

  4. Obtain API Key: Sign up at NewsAPI to get your API key.

  5. Configure API Key: Add your API key to the project by modifying the configuration file.

  6. Run the App: Run the app on an emulator or a physical device.

Usage

  • Browse News: Select different categories from the home screen to browse news.
  • Search News: Use the search bar to find specific news articles.
  • Refresh News: Pull down on the news feed to refresh the content.

Contributing

We welcome contributions to make Big News even better! If you have an idea for a new feature or find a bug that needs fixing, here is how you can contribute:

  1. Fork the Repository: Click the 'Fork' button at the top right of the repository page to create a copy of the repository on your GitHub account.

  2. Clone Your Fork: Clone your forked repository to your local machine.

    git clone https://github.com/Muhammad-Noman59/Big-News-Apps.git
  3. Create a Branch: Create a new branch for your feature or bug fix.

    git checkout -b feature-name
  4. Make Your Changes: Make your changes to the codebase.

  5. Commit Your Changes: Commit your changes with a clear and descriptive commit message.

    git commit -m "Add feature or fix bug: description"
  6. Push to Your Fork: Push your changes to your forked repository.

    git push origin feature-name
  7. Submit a Pull Request: Go to the original repository and create a pull request from your forked repository and branch. Provide a clear description of your changes and any related issue numbers.

  8. Review Process: Your pull request will be reviewed, and any necessary feedback will be given. Once approved, it will be merged into the main repository.

License

This project is licensed under the MIT License. You can find the details in the LICENSE file.

Acknowledgements

  • Thanks to the developers of Retrofit, Navigation, Coil, and Swipe Refresh libraries.
  • Special thanks to the open-source community for their resources and tutorials.

Supporting the Project

  • Financial Support: If you would like to support the development of Big News financially, you can make a contribution. Any amount is greatly appreciated and will be used to improve the app. You can contribute via Coin Drop.

Contact Me

https://www.facebook.com/profile.php?id=100092720556743 muhammad-noman59


gfi