Skip to content

A news feed application that displays different news sources and articles from well know news outlet

Notifications You must be signed in to change notification settings

iakhator/news-feed-application

Repository files navigation

News Feed application

Build Status Coverage Status Code Climate

Introduction

  • The News feed application consumes newsapi.org to display news sources and also current news headline. User have to sign in before it can be use. *To view the project visit this link

Key Features of this Application

  • Google plus sign in.
  • Search news sources.
  • View news sources.
  • View every article on the sources by sort.

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 click 'See More' or the 'Headline link' to be redirected to the source link.

Local Installation Guide

  • Ensure Node is installed
  • clone the repo with the following command git clone https://github.com/iakhator/news-feed-application.git
  • Run npm install to install all the dependencies needed to run the application
  • Install webpack globally
  • To test the application, run npm test
  • On your local machine Run npm start to start the server and visit http://localhost:5000

Technologies

  • ECMAScript 6: This is the newest version of JavsScript with new features such as arrow functions, spread and rest operators and many more.
  • REACT: REACT is a JavaScript framework developed by Facebook and it is used for developing web application. REACT is the 'VIEW' in the MVC architecture.
  • FLUX: Flux is an architecture used for building stable and efficient web applications. Flux design is a unidirectional flow of data.

Limitations

  • Users can only sign in with google plus.
  • Users cannot mark articles as favourites.
  • Users cannot view full article wthin application.
  • Users cannot share articles on Social media platforms.

What To Add In The Future

  • Users can log in with inputing email and password.

Contributions

Contributions are always welcome. If you are interested in enhancing the features in the project, follow these steps below:

  • Fork the project to your repository then clone it to your local machine.
  • Create a new branch and make features that will enhance it.
  • If the you wish to update an existing enhancement submit a pull request.
  • If you need clarification on what is not clear, contact me via mail [email protected]

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author

Akhator Itua - iakhator

About

A news feed application that displays different news sources and articles from well know news outlet

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published