Skip to content

🦒Deploy staging environments for your static sites on Github Pages

Notifications You must be signed in to change notification settings

sigmachirality/kirin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kirin 🦒

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.

Limitations

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.

Why "Kirin"?

It's an oblique reference to the Giraffe from Revue Starlight.

Getting Started

WIP

Maintainers

This library is maintained with ❤️ by me, sigmachirality.

About

🦒Deploy staging environments for your static sites on Github Pages

Topics

Resources

Stars

Watchers

Forks