JSPM

@hyperlane-xyz/github-proxy

5.2.1-beta.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3
  • Score
    100M100P100Q20232F
  • License Apache-2.0

Github proxy that adds the API key to requests

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@hyperlane-xyz/github-proxy) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Github Proxy

    Overview

    Github Proxy is a CloudFlare Worker that makes a Github API requests using an API key. This authenticated method allows higher limits than the non-authenticated mode.

    Keys

    Acquire a Github api key by creating a new fine-grained personal access token.

    Local Development

    Prerequisites: Copy the .dev.vars.example and add the Github API key.

    Development is managed by the Wrangler CLI. To start dev mode execute yarn dev. This will start a local server.

    Testing

    Unit tests can be executed using yarn test.

    Deployment

    Execute yarn deploy to deploy to production. Note that the deployment requires permissions. To deploy to a staging environment use yarn deploy:staging. Use yarn deploy:key to attach the Github key to the Worker.