CipherLabs
/
hyperlane-monorepo
mirror of https://github.com/hyperlane-xyz/hyperlane-monorepo
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
The home for Hyperlane core contracts, sdk packages, and other infrastructure
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2653 Commits
487 Branches
328 Tags
237 MiB
 
 
 
 
 
 
Tag: Branch: Tree: d010772bb8
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'd010772bb8'
${ noResults }
hyperlane-monorepo/typescript/github-proxy
History
github-actions[bot] 3857cfb65a
Version Packages (#4535) 		2 months ago
..
src fix: Add recursive query string (#4507) 3 months ago
test feat: Add github proxy (#4418) 3 months ago
.dev.vars.example feat: Add github proxy (#4418) 3 months ago
.gitignore feat: Add github proxy (#4418) 3 months ago
CHANGELOG.md Version Packages (#4535) 2 months ago
README.md fix: Add recursive query string (#4507) 3 months ago
package.json Version Packages (#4535) 2 months ago
tsconfig.json feat: Add github proxy (#4418) 3 months ago
vitest.config.ts feat: Add github proxy (#4418) 3 months ago
worker-configuration.d.ts feat: Add github proxy (#4418) 3 months ago
wrangler.toml feat: Add github proxy (#4418) 3 months ago

README.md

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.