Giter VIP home page Giter VIP logo

openweatherservice's Introduction

Weather API service

This is a API service in NodeJS to demonstrate a simple proxy service to the open weather API with support for caching and ratelimiting. All the required values for ratelimiting and caching are configuration driven via config directory. Caching is LRU but in a real deployment use distributed in-memory cachers like Redis.

The service can be easily extended to support any backend API service by writing a client that extends the api base client.

Getting started

Setup instructions & system requirements

Install Git and NodeJs v6 or above

Setup:

  git clone 'this repo'
  npm install

Usage

  > node app/server.js

Unit tests

The tests are written using a BDD. NodeJS has an extensive library collection to support BDD. This repo uses mocha, assert, should and Sinon.

  > grunt unit-test

Coverage

  > ./node_modules/.bin/istanbul cover ./node_modules/mocha/bin/_mocha ./test/**/*.test.js -- -R spec

Running

The server runs default on 8009 port localhost.

http://localhost:8009/weather/country/au/city/melbourne?api_key=<your apikey>

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.