Git Product home page Git Product logo

yelp-finder's Introduction

Yelp Sample app.

Design/Architecture considerations

  • The chosen architecure is Model-View-ViewModel
  • Because of the nature of the app. Search -> Results -> Details. The model is not persistent
  • Searches are cached for 15 minutes.
  • App is implemented using Jetpack's architecture components.
    • Live Data
    • Navigation
    • ViewModel
    • Databinding
  • Dependency Injection using dagger 2.

Running

  • Yelp Client Id and API Key must be included in local.properties
    • Example:
      yelpClientId="CLIENT_ID"
  yelpAPIKEY="API_KEY"

Tests

  • Unit tests and integration tests are included.

TODO/Out of Scope

  • Yelp search endpoint requires lat/lon, getting the user's location is not implemented and location is Defaulted to NYC. (Lots of businesses)
  • Search list will show up to 50 results. Paging/Infinite scroll is not implemented.
  • Espresso Idling resources are not implemented.
  • Test coverage is not complete.

yelp-finder's People

Contributors

fedeperez89 avatar

Watchers

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.