Git Product home page Git Product logo

api's Introduction

APP DESCRIPTION

Climate Change News API is a web application that allows users to retrieve the latest news articles related to climate change from various sources. The application uses web scraping techniques to fetch news articles from multiple newspapers' websites and provides the users with a JSON API to access the data.

USER STORY

As a user, one can access the latest news articles about climate change from various newspapers in one place. The Climate Change News API allows one to request news articles from specific newspapers or get all the articles from different sources.

DEVELOPMENT REQUIREMENTS

To run the Climate Change News API, you will need the following:

  • Node.js (>=12.0.0) and NPM (Node Package Manager) installed on your machine.
  • Express.js
  • Axios
  • Cheerio and other required Node.js modules (specified in package.json).

INSTALLATION

To use this repository on your machine do the following simple steps:

  • Open a terminal / command line interface on your computer.

  • Clone the repo by using the following to create a copy on your local machine:

       [email protected]:Musyoki-Wambua/api.git
    
  • Change the working directory to the project folder:

      cd api
    
  • (Optional) Open it in Visual Studio Code:

      code . 
    

RUNNING APP

To run the Climate Change News API, execute the following command in the terminal:

  • Run npm install to install the necessary dependencies.

      npm install 
    
  • To launch the server

      npm start
    

The API will start running on the specified PORT, and you can access it using the base URL.

You can also click here to launch the live link

ENDPOINTS

  • GET /news:

Retrieves all the latest news articles related to climate change from various newspapers.

  • GET /news/:newspaperId:

Retrieves news articles related to climate change from a specific newspaper.

For example:

    base URl/news/guardian:        

AUTHOR

The Climate Change News API was developed by Joseph Wambua.

api's People

Contributors

musyoki-wambua avatar

Watchers

 avatar

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.