Public | Automated Build

Last pushed: 2 years ago
Short Description
API to fetch a list of plugins on npm/github
Full Description

yeoman-generator-list

Serves a list of all Yeoman generators as JSON via HTTP.

Configuring the Environment

Variables

NPM_LIST_KEYWORD

(optional)<br>
Default: yeoman-generator

You can set the NPM_LIST_KEYWORD environment variable if you wish to search npm packages matching a custom keyword.

GH_LIST_LIMIT

(optional)<br>
No Default

Sets the number of GitHub queries to max out at. It should be low in development so the rate limit is not hit. 5000 is the current per hour limit that GitHub has defined.

UPDATE_INTERVAL_IN_SECONDS

(optional)<br>
Default: 3610

The time between when the list is refreshed in seconds. GitHub's API refresh time is one hour so set it a little longer than that.

GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET

(required)

These are the properties to be able to use the GitHub API. These are needed since GitHub allows more API usage for registered apps.

You can get them by registering a new OAuth app on GitHub.

NewRelic

  • NEW_RELIC_APP_NAME
  • NEW_RELIC_LICENSE_KEY
  • NEW_RELIC_LOG_LEVEL

Google Cloud Storage

  • GCLOUD_PROJECT_ID
  • GCLOUD_BUCKET
  • GCLOUD_KEYFILENAME: JSON File relative to this project that has the gcloud credentials

Running with Docker (using Heroku toolbelt)

TODO: (needs updated instructions)

We'll assume you're using Docker Toolbox on macOS. Steps may vary on other platforms.

To run the project locally:

# Start docker
docker-machine start default

# Make sure you source the environment
eval "$(docker-machine env default)"

# Then start the app
docker-compose up web

Running manually

  • Install dependencies: $ npm install
  • Run npm start

License

BSD license
Copyright (c) Google

Docker Pull Command
Owner
yeoman
Source Repository

Comments (0)