diff options
| author | Joe Mou <dev@mou.fo> | 2026-09-18 07:42:53 +0100 |
|---|---|---|
| committer | Joe Mou <dev@mou.fo> | 2026-09-18 08:11:33 +0100 |
| commit | 363e8db444d9aade0fcca2bd3171653b7dab01d8 (patch) | |
| tree | 64ef8ee4dc22ddb5313c6599e8e32754bb492991 /cgithub/README.md | |
| parent | 9659525bf2387af6deab9d401784b94b1f44d395 (diff) | |
Run cgithub locally on elmotest
Diffstat (limited to 'cgithub/README.md')
| -rw-r--r-- | cgithub/README.md | 26 |
1 files changed, 23 insertions, 3 deletions
diff --git a/cgithub/README.md b/cgithub/README.md index 45c94cf..135e5ce 100644 --- a/cgithub/README.md +++ b/cgithub/README.md @@ -1,10 +1,30 @@ cgithub is a lightweight GitHub alternative frontend. It has no bloated -JavaScript and doesn't require API keys. It runs on Cloudflare Workers; to use -it, deploy your own instance then replace `github.com` in your URL with your -domain. +JavaScript and doesn't require API keys. It can run on Cloudflare Workers or +as a local Node server; to use it, run your own instance then replace +`github.com` in your URL with your domain.  +## Development + +Run the Cloudflare version locally with: + +```sh +pnpm run dev +``` + +Run the Node server locally with: + +```sh +pnpm run dev:local +``` + +To deploy the Worker to Cloudflare: + +```sh +pnpm run deploy +``` + ## Features Implemented: |