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.
Acquire a Github api key by creating a new fine-grained personal access token.
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.
Unit tests can be executed using yarn test
.
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.