Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 2.95 KB

README.md

File metadata and controls

55 lines (42 loc) · 2.95 KB

News Feed application

Coverage Status Build Status Code Climate

Introduction

  • The News feed application consumes a news api to view new sources and also current new headline. The app requires the user to sign in with a google plus account and the app has more than 60 news sources to choose from. The application offers an easy to use responsive UI. To view the project visit this link

Key Features of this Application

  • Google plus sign in.
  • Search for new sources.
  • View new sources.
  • Sort articles for every news sources.
  • View every article on the sources homepage.

Usage

  • Sign in with Google plus account to view news sources.
  • Search for any news source and view their articles.
  • Scroll through the news sources and sort between top and latest news articles.
  • On the headline link click 'READ MORE' to be redirected to the source link.

Local Installation Guide

  • Ensure NodeJS is installed
  • clone the repo with the following command git clone https://github.com/andela-johia/news-feed-app.git
  • Run npm install to install all the dependencies needed to run the application
  • Install webpack globally
  • To test the application, run npm test
  • Run npm run dev to start the server and visit http://localhost:8080

Technologies

  • ECMAScript 6: This is the newest version of JavsScript with new features such as arrow functions, spread operator and many more.
  • REACT: REACT is a JavaScript library that was developed by Facebook and is used for developing web application. REACT is the 'VIEW' in the MVC architecture. Web pages are structured in REACT with componenents which are very dynamic.
  • FLUX: Flux is an architecture used for building stable and efficient web applications. Flux design is basically a unidirectional flow of data.

Limitations

  • Users are only able to sign in with google plus.
  • Users cannot mark articles as favourites.
  • Users cannot share articles on Facebook or Twitter.

Contributing to News Feed Application

Contributions are always welcomed to the project. If you are interested in enhancing the features in the project, follow these simple steps:

  • Fork the project to your repository then clone it to your local machine.
  • Create a new branch and make the necessary enhancement to the features.
  • If the you wish to update an existing enhancement submit a pull request.
  • If you are unsure about certain areas in the project feel to ask for assistance.

License

This project is authored by Johnbosco Ohia it is licensed under the MIT license.