README.md

Fetch Service

This project is responsible for generating the Web Components list on CustomElements.io.

And here's what we do to accomplish that:

1. Grabs the static list of Web Components.
2. Fetches all the information from GitHub's API based on that list.
3. Merges this list with all Bower components tagged with web-components and with all NPM modules tagged with web-components
4. Generates an output in JSON format.

Maintainer: Djalma Araújo

Requirements

• Node
• Redis

Environment vars

$ export REDISTOGO_URL
$ export BOWER_API_URL
$ export CUSTOMELEMENTS_API_URL
$ export NPM_API_URL
$ export BLACKLIST_API_URL
$ export FETCH_INTERVAL
$ export GITHUB_API_URL
$ export GITHUB_USERNAME
$ export GITHUB_PASSWORD

Installation

$ git clone [email protected]:webcomponents/fetch-service.git
$ npm install

Run

$ node server

Deploy

$ git push heroku master

License

MIT License © WebComponents.org