8000 GitHub - efeguono/E-News: A React-Flux news feed application that delivers news headlines from 70 news sources worldwide
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

A React-Flux news feed application that delivers news headlines from 70 news sources worldwide

Notifications You must be signed in to change notification settings

efeguono/E-News

Repository files navigation

Code Climate Build Status Coverage Status

E-News

Introduction

E-News is a News Feed Application that makes use of an API to display various News Sources with their corresponding Headlines based on the various options(top, latest e.t.c). The link to the hosted app E-News

Features

  • Search for News Source
  • View Headlines based on News Source
  • Sort Headlines based on e.g Top Headlines, Latest Headlines

How users can get started with the project

  • Requirements
    • To run the app locally, you need to have node.js installed
  • How to setup the project/Installation/Configuration
    • Clone the repo git clone https://github.com/andela-eefekemo/E-news.git
    • Change directory into E-News folder
    • Run npm install to install all dependencies
    • Run npm start to run the application
  • How to run tests
    • Run npm test

How to use the app

When the app has started:

  • Click on Login to upload assess the application
  • Upon successful login. Use the Search Field to search for News Source
  • Click on View Headlines to view the news headlines of News Source.
  • Use the Sort Field to views news based on the sort by available.

Technology stack

  • Node JS - Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine.
  • React - React is a JavaScript library for building user interfaces.
  • Webpack - webpack is a module bundler for modern JavaScript applications.
  • Babel - Babel is a JavaScript compiler, it is used for transpiling ES6 down to ES5.
  • Express - Express is a minimal and flexible Node.js web application framework, It is used as the web server.
  • Jest - Complete and easy to set-up JavaScript testing solution. Works out of the box for any React project.
  • Axios -A Promise based HTTP client for the browser and node.js. Used in making the Api Call.

Limitations of the project

  • The Application uses only Google Login as a form of Authentication
  • The Application does not display stories on the site
  • The Application can not save favorite articles for later viewing

Contributing to the project

  • Fork this repositry to your account
  • Clone your repositry - git clone https://github.com/andela-eefekemo/E-News.git
  • Create your feature branch - git checkout -b new-feature
  • Commit your changes - git commit -m "did something"
  • Push to the remote branch - git push origin new-feature
  • Open a pull request

Troubleshooting & FAQ

Resources

  • For further research on The News Api, click here

License

  • MIT

Author

  • Eguonoghene Efekemo

About

A React-Flux news feed application that delivers news headlines from 70 news sources worldwide

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0