jheidepriem / ny-times-reader

Visit NYT Reader

Table of Contents

• Setup
• Technologies
• Project Spec
• Abstract
• Learning Goals
• Preview/TechStack
• Deployment
• Testing
• Deployment
• Testing
• Authors

Setup

• Clone down this repo here
• On the command line, type: $ npm install
• On the command line, type: $ npm start
• Open http://localhost:3000 to view it in your browser.
• The page will reload when you make changes.
• You may also see any lint errors in the console.

Technologies

• Javascript
• CSS / HTML
• VSCode
• Git Version Control / GitHub
• Webpack node package
• React
• Router
• Google Chrome or Web Browser of User's Choice
• Mac OS Terminal/Command Line
• Cypress

Project Spec

Click Here

Abstract

New York Times Reader is an App that gives users all of the top articles of the day, article details, and a link the article on the New York Times Website.

Learning Goals

• A strong understanding of React JS and Front-End best practices
• Your ability to prioritize for MVP
• An understanding of basic usability practices and standards
• A clear hierarchy of information
• Clean, well thought out code

Preview

Planning Document -

Testing

• Successfully implemented 80-90% test coverage for all components.

Future features would include a navigation bar to sort articles by subject.

Deployment

HERE

Authors

Josephine Heidepriem GH

ny-times-reader's Issues

Test for accessibility

Use lighthouse for accessibility

Create a simple main page

A user opens the app and is taken to a page of the most recent New York times articles and a search bar if the user wants to find a particular article

Add cypress tests

Add cypress tests for

• The main article Library
• The article details page
• The navigation between pages

Create an article details page

A user clicks on an article on the main page and is navigated to an articles detail page that includes

• Article title
• Article Photo
• Article Summary
• A link the article on the New York Times website
• A button logo to go back to the main page

Create ReadMe

Create ReadMe that includes

• Setup instructions
• Preview
• Planning Figma Image
• Testing
• Accessibility
• Learning Goals
• Rubric