shawnmcmahon/nyt-reader

NYT Reader

Table of Contents

• Overview
• Learning Goals
• Instructions for Viewing
• Walkthrough
• Tech Stack
• Future Features
• Contributors

Overview

The mission for this project was to build to a New York Times News Reader app within 8 hours. The application utilizes the New York Times Top Stories API. Users can pick from a selection of Top Story categories and see a summary view of the top stories from that day. Each summary leads to a detailed article view where more information is available about that story. User's are able to navigate to that New York Times article directly from the app to read the entire story.

Learning Goals

• Create a functional news reader app within 8 hours
• Build upon the foundational skills of React
• Utilizes React Router for url navigation
• Implement client-side testing with Cypress

Instructions for Viewing

1. In your desired directory, type git clone git@github.com:shawnmcmahon/nyt-reader.git
2. cd into 'nyt-reader'
3. Type npm install
4. Type npm start.
5. Program will open inside the browser at http://localhost:3000/

Walkthrough

To be added when application is complete.

Tech Stack

React w/ Hooks	React Router	Cypress	JavaScript

Future Features

• Implement additional NYT Times APIs besides Top Stories
• Implement APIs from news sources
• Dark Mode

Contributors

Shawn McMahon

A Mod 4 Project for Turing School of Software & Design