newertkrocker / news-reader

A news reader prototype done as practice for Turing.

NYT News Reader app

Table of Contents

• Abstract
• Illustrations
• Install + Setup
• Contributors

Abstract

This little React app was a take-home assignment from Turing School of Software & Design; a chance to meet a spec within a short period of time as practice scoping, designing, and executing a project in just a day or two. (You can read the spec here, if you're interested!) It pulls stories and information from the New York Times' Top Stories API, provides a "detail view" for headlines you click on, and offers a link to the NYT's website to read the full stories. It also lets you sort stories by section!

You can view the project's wireframe here.

Illustrations

Install + Setup

To run this project locally:

• Run git clone [email protected]:NEwertKrocker/news-reader.git in your terminal
• cd news-reader
• Run npm install to install all dependencies
• Run npm start
• The project should open in your browser!

Contributors

• Nate Ewert-Krocker

news-reader's Issues

Prepare and upload README

The rubric says a competent project will have "clear documentation including sections like a summary, setup instructions, endpoints/wireframes, testing instructions, etc." Let's prepare that in the README.

Add responsive design

The MVP says the app "should be usable on desktop, tablet, and mobile devices," so let's make sure that's true.

Filter stories by section

As a user, I should be able to access a list of the NYT's sections and filter stories to include only headlines from the relevant section.

Code for embedded IMG crashes app on open

For whatever reason, I can embed an image just fine once the fetch call has been made, but if I refresh the page, React crashes, telling me that the path to the img url is undefined. I even tried to put some conditional rendering there, but it didn't like it either way. Let's mess with it again tomorrow.

Detail view for stories

As a user, when I click on a headline in the list of stories, I should see a "detail view" pop up with additional information about the story.

List of news stories

As a user, when I navigate to the page, I should see a list of news headlines pulled from the NYT's Top Stories API.