@hyperlane-xyz/github-proxy

5.2.1-beta.0 • Public • Published

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.

Dependencies (0)

    Dev Dependencies (8)

    Package Sidebar

    Install

    npm i @hyperlane-xyz/github-proxy

    Weekly Downloads

    31

    Version

    5.2.1-beta.0

    License

    Apache-2.0

    Unpacked Size

    6.21 kB

    Total Files

    12

    Last publish

    Collaborators

    • cmcewen
    • yorhodes
    • nambrot
    • jmrossy