yamadapc/github-trending-api repository overview

⁠github-trending-api

This module is an API for the github-trending NPM module. So it can be ran as an "ultra-micro-service". It has an in-memory cache for results; so mostly you can use it from another point of the application and not worry about anything else.

It exposes a standalone express app, which can be ran from the command-line with:

$ npm install github-trending-api
$ github-trending-api

And an express.Router instance, which is what require('github-trending-api') returns.

A write-up on its stack is pending.

⁠Docker

This repository has automated image builds on hub.docker.com. So you can also run:

$ docker-machine start default
$ eval $(docker-machine env default)
$ docker run -it -p 3000:3000 yamadapc/github-trending-api
$ curl `docker-machine ip default`:3000/repositories

⁠Endpoints

⁠GET /repositories

Responds with a list of trending repositories; accepts an optional language QueryString parameter.

⁠GET /languages

Responds with the list of valid languages.

⁠License

This code is licensed under MIT license. See LICENSE⁠.