joy0520 / NYTimesViewer

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Project 2 - NYTimesViewer

NYTimesViewer is an android app that allows a user to search for articles on web using simple filters. The app utilizes New York Times Search API.

Time spent: 22 hours spent in total

User Stories

The following required functionality is completed:

  • User can search for news article by specifying a query and launching a search. Search displays a grid of image results from the New York Times Search API.
  • User can click on "settings" which allows selection of advanced search options to filter results
  • User can configure advanced search filters such as:
    • Begin Date (using a date picker)
    • News desk values (Arts, Fashion & Style, Sports)
    • Sort order (oldest or newest)
  • Subsequent searches have any filters applied to the search results
  • User can tap on any article in results to view the contents in an embedded browser.
  • User can scroll down to see more articles. The maximum number of articles is limited by the API search.

The following optional features are implemented:

  • Implements robust error handling, check if internet is available, handle error cases, network failures
  • Used the ActionBar SearchView or custom layout as the query box instead of an EditText
  • User can share an article link to their friends or email it to themselves
  • Replaced Filter Settings Activity with a lightweight modal overlay
  • Improved the user interface and experiment with image assets and/or styling and coloring

The following bonus features are implemented:

The following additional features are implemented:

  • Do Search again after search filter changed based on previous search string.
  • Add a 2-second delay before loading next page.

Video Walkthrough

Here's a walkthrough of implemented user stories:

GIF created with Gif Maker - Gif Editor.

Notes

Describe any challenges encountered while building the app.

Open-source libraries used

  • Android Async HTTP - Simple asynchronous HTTP requests with JSON parsing
  • Android CardView - A FrameLayout with a rounded corner background and shadow.
  • Android RecyclerView - Powerful version of ListView
  • ButerKnife - Field and method binding for Android views
  • Gson - A Java serialization/deserialization library that can convert Java Objects into JSON and back.
  • Glide - Image Loader Library for Android, recommended by Google
  • Parceler - Android Parcelable code generator for Google Android

License

Copyright [2017] [joy0520]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About


Languages

Language:Java 100.0%