QuickWit

Table of Contents

• About the Project
• Installation
• Functionality
• User Feedback
• Learning Goals
• Future Iterations
• Technologies Used
• Contributors
• Contact

About the Project

QuickWit is an application designed for users to quickly learn about top stories published by the New York Times. This take home tech challenge implemented the New York Times API Top Stories API (view documentation) to display top stories basic information. Users have the ability look through all top stories and can sort stories based on relevant story tags. When a user selects an article they can view that article's abstract, a photo (if applicable), and have the option to go to the New York Times website to read the full article. The take home challenge was reccommended to take approximately 6 hours. The project specs and rubic are from the Turing School of Software and Design and can be seen here for the specs and here for the rubric.

Installation

1. Fork this repository.
2. Clone it down to your local machine with git clone <your SSH Key>.
3. Navigate into this directory with cd quickwit.
4. Run npm install to compile the React application.
5. Run npm start to see the app running locally.
6. Run <your text editor> . to see the code in your text editor.

Functionality

• Mobile View
• Desktop View

Mobile View

• QuickWit is a mobile first platform, allowing for quick scrolling through the site on phones and tablets.

Desktop View

• If a user wants to view the site from a their desktop QuickWit is responsive, also giving the user hover states for various buttons.

Learning Goals

• Create a presentable project given a tight timeframe.
• Practice presenting a take home challenge.
• Create an app based solely on functional components via React Hooks.

Future Iterations

• Utilize all images provided in the given API.

Technologies Used

• 
• 
• 
• 
• 

Contributors

• Connor Anderson-Larson - Application Creator

Contact