Giter VIP home page Giter VIP logo

asedeyhot-news's Introduction

Build Status Coverage Status Code Climate

AsEDeyHot

This news feed application gathers latest, popular, and top headlines from around the globe. It consumes the NewsAPI which provides at least 60 news sources - including CNN,BBC, and TechCrunch.

App Features
  • A user can view sources from at least 60 news sites from around the globe
  • A user can view articles from a particular news source(e.g BBC News)
  • A user can sort headlines and view them (depending on the available sort parameters for that particular news source)
  • A user can favourite a news source or article. This functionality can only be accessed when the user is signed in with a google plus account.

Technology

This application was developed purely with JavaScript using React and the Flux Architecture, NodeJs, and Express.

Dependencies

Getting Started

  • Clone the project from repository github.com/andela-efalayi/asedeyhot-news
  • In your terminal, cd into the cloned folder and run npm install. This installs all the app's dependencies.
  • Run npm start in your terminal, open your browser, and type localhost:3000. This runs the application on your local machine.
  • Alternatively, you can access the app on asedeyhot-news.herokuapp.com

How to Contribute

I welcome any form of contribution. If you feel something can be done better or there's an issue that needs to be fixed or you are just interested in a specific part of the project, but not sure where to begin, feel free to ask. On the other hand if the contribution you wish to make has not been documented in an existing issue, please create new issue before submitting your pull request.

Limitations

- Presently, this news app can not share articles/headlines.
- News articles cannot viewed directly on the app.

Testing

All app components, actions, and stores were tested using Facebook's Jest The test files can be found in the tests folder.

  • To run the tests, run npm test on the command line. This automatically runs jest on all test files.
  • You can also run jest directly. However, jest-cli needs to be globally installed on your machine.

License

MIT © 2017 | Esther Falayi | Andela, Nigeria

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.