NewsApp

A modern Android application built with Kotlin and Jetpack Compose, providing live news articles from NewsAPI.org

📱 Screenshots

HomeScreen Light

DetailsScreen Light

HomeScreen Dark

DetailsScreen Dark

🗂️ Table of Contents

• Features
• Installation
• Screenshots
• Project Structure
• Tech Stack
• License
• Notes
• Contact

✨ Features

• 📰 Latest News Feed: Browse the latest news articles from the source.
• 📖 Detailed Article View: Tap on an article to view its detailed content
• 🚀 Smooth Navigation: Seamless navigation between screens using Jetpack Compose Navigation
• 🧠 UI State Handling: Manage UI state with ViewModel and Compose
• ⚡ Asynchronous Data Loading: Fetch data asynchronously with Kotlin Coroutines
• 🖼️ Image Loading: Efficient image loading with Coil
• 🧩 Dependency Injection: Use Hilt for dependency management
• 🌐 Kotlin-First Networking: Built with Ktor for type-safe, multiplatform-ready API calls

---

📦 First Stable Release: v1.0

🛠 Installation

To set up the project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/chrysophilist/NewsApp.git
   

2. Open in Android Studio:
   • Launch Android Studio.
   • Select Open an existing project and navigate to the cloned repository folder.
3. Install dependencies:
   • Ensure you have the Android SDK configured.
   • Sync the project with Gradle (via File → Sync Project with Gradle Files).
4. Add your NewsAPI key:
   • Create a file local.properties in the project root (if not present).
   • Add:

   NEWS_API_KEY=your_api_key_here
   

5. Run the app:
   • Connect an Android device or use an emulator.
   • Click Run in Android Studio to build and deploy the app.

📁 Project Structure

NewsApp/
├── app/
│   ├── manifests/
│   │   └── AndroidManifest.xml         # App manifest
│   ├── java/com/prince/newsapp/
│   │   ├── NewsApp.kt                  # Application class (Hilt Base app)
│   │   ├── MainActivity.kt             # Launch activity
│   │   ├── di/                         # Dependency Injection (Hilt modules)
│   │   │   └── Modules.kt
│   │   ├── models/                     # Data classes for API responses
│   │   │   ├── Article.kt
│   │   │   ├── NewsResponse.kt
│   │   │   └── Source.kt
│   │   ├── navigation/                 # Compose navigation components
│   │   │   ├── NewsAppRoute.kt
│   │   │   └── NewsNavApp.kt
│   │   ├── network/                    # API service interfaces
│   │   │   └── NewsApiService.kt
│   │   ├── repo/                       # Repository layer
│   │   │   └── NewsRepository.kt
│   │   ├── ui/
│   │   │   ├── components/            # Reusable UI components
│   │   │   ├── views/                 # App screens (Home, Details)
│   │   │   └── theme/                 # Theme, colors, typography
│   │   │       ├── Color.kt
│   │   │       ├── Theme.kt
│   │   │       └── Type.kt
│   │   └── viewModels/                 # ViewModels & UiStates
│   │       ├── NewsViewModel.kt
│   │       ├── NewsUiState.kt
│   │       ├── NewsDetailsViewModel.kt
│   │       └── NewsDetailsUiState.kt
├── res/                                 # Resources
├── build.gradle.kts                     # Module-level Gradle build script
└── settings.gradle.kts                  # Project settings

🏗 Tech Stack

🧠 Core

• Language: Kotlin
• Architecture: MVVM (Model-View-ViewModel)
• State Management: ViewModel + Coroutines
• Serialization: Kotlinx Serialization

🎨 UI

• Framework: Jetpack Compose
• Navigation: Navigation Compose
• Design Principles: Declarative UI + Reactive State Handling

⚙️ Data & Networking

• Networking: REST APIs via Ktor Client
• Data Source: NewsAPI – Global news data provider

🧩 Tooling

• Dependency Injection: Hilt / Dagger
• Build System: Gradle (Kotlin DSL)

📄 License

This project is licensed under the MIT License. See LICENSE for details.

📝 Notes

• You need a free API key from NewsAPI.org to fetch live news.
• Make sure to add your API key in the appropriate configuration file (e.g., build.gradle or Local.properties).

👤 Contact

For questions or feedback, reach out to:

• Email: princekumarjnvmdb@gmail.com
• LinkedIn: princekr2480

This site is open source. Improve this page.