Kirin is a framework agnostic Github Action which provides a Github Pages staging environment for static sites. When Kirin is targeted to a pages site at <OWNER>.pages.github.com/<REPO> hosting the repo <OWNER>/<REPO>, a branch with <BRANCH_NAME> trigger a build which deploys its contents to <OWNER>.pages.github.com/<REPO>/<BRANCH_NAME>.
As opposed to Vercel, Netlify, and Heroku, Kirin is more lightweight, transparently configurable, and most importantly, completely and utterly free.
Because of how routers are implemented in packages like react-router and frameworks like NextJS and Gatsby, you will have to use the provided getKirinBasePath helper to set the base path at build time.
It's an oblique reference to the Giraffe from Revue Starlight.
WIP
This library is maintained with ❤️ by me, sigmachirality.