The Buzz

Table of Contents

• Application Features
• Requirements
• Getting Started
• Languages & Tools
• License

Application Features

• Each article contains a photo, a headline, and a description. Upon clicking the See More button, users can then see the article's content, published date, and news source
• Users can submit a word in the search bar and return a list of relevant news articles
• Users can save their favorite articles by selecting the ★ and the article is saved to their favorites, which can be found at the Favorites link in the nav bar
• Each set of articles, favorites, and search results has been paginated with a limit of five articles per page

Requirements

To run this app, you will need Node.js and yarn installed on your environement

You will also need to get an API key from NewsAPI

Getting Started

Install

$ git clone https://github.com/ajyan/the-buzz.git
$ cd client
$ npm install

Configure .env

Within the client directory, create a .env file and paste in your News API Key as REACT_APP_NEWS_API_KEY = YOUR_KEY_HERE

Start & Watch

$ npm start

The application will be running on port 3000

Simple build for production

Within the client directory:

$ npm run build
$ serve -s build

The application will be running on port 5000

Languages & Tools

JavaScript

• React is used for UI

CSS

• Bootstrap as a basic styling framework

HTTP Client Requests

• Axios to handle client side requests to the News API

License

MIT