https://github.com/Jiaocz/CloudFlare-Pages-UrlShorten
☁ Url Redirector based on CF Pages.
https://github.com/Jiaocz/CloudFlare-Pages-UrlShorten
cloudflare-pages cloudflare-pages-functions
Last synced: 7 months ago
JSON representation
☁ Url Redirector based on CF Pages.
- Host: GitHub
- URL: https://github.com/Jiaocz/CloudFlare-Pages-UrlShorten
- Owner: Jiaocz
- License: mit
- Created: 2022-08-14T07:25:43.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-25T15:27:47.000Z (over 2 years ago)
- Last Synced: 2023-05-25T16:27:53.163Z (over 2 years ago)
- Topics: cloudflare-pages, cloudflare-pages-functions
- Language: TypeScript
- Homepage: https://cz.cyou
- Size: 83 KB
- Stars: 15
- Watchers: 1
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cloudflare - CloudFlare-Pages-UrlShorten
- awesome-cloudflare-applications - CloudFlare-Pages-UrlShorten
README
# CloudFlare Pages UrlShorten
Deploy this repo to your CloudFlare Pages,
Create a [Worker KV](https://dash.cloudflare.com/?to=/:account/workers/kv/namespaces),
Bind this Worker KV in your Pages project in `Settings > Functions > KV namespaces bindings` with `Variable name` called `UrlShorten`,
Done
## Deploy
### Deploy settings
| Setting | Value |
| -- | -- |
| Build command | `npm run build` |
| Build output directory | `/dist` |
| Root directory | `/` |
### Environment variables (recommended)
You could use any node version later than 16.
| Variable name | Value |
| -- | -- |
| NODE_VERSION | `16.17.1` |
### Functions (necessary)
I assume you have created a [KV namespace](https://dash.cloudflare.com/?to=/:account/workers/kv/namespaces) for this Pages project.
| Variable name | KV namespace |
| -- | -- |
| UrlShorten | _the one you created_ |
Other settings are not necessary.
## Add a path
Add it to KV like:
| Key | Value |
| --- | --- |
| **path** | **real url** |
| [`/blog`](https://cz.cyou/blog) | https://blog.orangii.cn |
| `/more` | https://example.org |
## Gravatar Mirror
Check this out:
https://cz.cyou/avatar/02e96d02a7364a53f44168f4beb7067c
## Github Static File Mirror
Test with this README.md
- Origin: [https://raw.githubusercontent.com/Jiaocz/CloudFlare-Pages-UrlShorten/feat/functions-dir/README.md](https://raw.githubusercontent.com/Jiaocz/CloudFlare-Pages-UrlShorten/feat/functions-dir/README.md)
- Mirror: [https://cz.cyou/**gh/https://raw.githubusercontent.com/Jiaocz/CloudFlare-Pages-UrlShorten/feat/functions-dir/README.md**](https://cz.cyou/gh/https://raw.githubusercontent.com/Jiaocz/CloudFlare-Pages-UrlShorten/feat/functions-dir/README.md)
Just add origin link to cz.cyou (or your deployed instance).
`https://cz.cyou/gh/${origin_link}`
## Credits
Github Mirror function from [hunshcn/gh-proxy](https://github.com/hunshcn/gh-proxy)