Skip to content

ShawnDuan/MyNews

Repository files navigation

Project 2 - MyNews

MyNews 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: 30 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 image in results to see the full text of article full-screen
  • 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:

  • RxJava + Retrofit
  • Fragment transaction
  • Use Stecho for network inspection.

Video Walkthrough

Here's a walkthrough of implemented user stories:

Video link

Notes

Fragment transaction is tricky. If you want to dynamically replace/add fragment, the clean way is to create a container(placeholder) in activity layout, and do fragment transaction replace/add based on the container id.

Open-source libraries used

  • Android Async HTTP - Simple asynchronous HTTP requests with JSON parsing
  • Picasso - Image loading and caching library for Android

License

Copyright [2016] [Shawn Duan]

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

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages