Giter VIP home page Giter VIP logo

nytimes-compose's Introduction

The NewYork Times App (work-in-progress)

An offline first application in Jetpack Compose with MVVM architecture, representing a minimalistic implementation of Top Stories API. Built with components like DataStore, Coroutines, ViewModel, LiveData, Room, Navigation-Compose, Coil-Accompanist, koin etc.

This sample showcases:

  • UI state management
  • Basic Material Design theming (Light & Dark)
  • Offline First Functionality
  • Integration with Architecture Components: Navigation, ViewModel, Room
  • Minor features like Pull-to-refresh, dedicated settings screen, Time-bounded refresh, Dialogs etc.

Getting Started

To try out this sample app, you need to use the latest Canary version of Android Studio.

This project uses the Gradle build system. To build this project, use the gradlew build command or use "Import Project" in Android Studio.

For more resources on learning Android development, visit the Developer Guides at developer.android.com.

New York Times API key

NY Times-Compose uses the Top Stories API from New York Times to load stories on home screen. To use the API, you will need to obtain a free developer API key. See the New York Times API Documentation for instructions.

Once you obtain the api key create a file apikey.properties in the root folder and add this line

API_KEY=<your api key>

Screenshots

Upcoming features

Updates will include incorporating additional Jetpack components and updating existing components as the component libraries evolve.

Interested in seeing a particular feature of the Android Framework or Jetpack implemented in this app? Please open a new issue.

License

Licensed under the Apache License, Version 2.0, click here for the full license.

Author & support

This project was created by Akshay Sharma.

If this project help you reduce time to develop, you can give me a cup of coffee :)

paypal

nytimes-compose's People

Contributors

akshay2211 avatar e4basil avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.