Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0-vortex/cf-workers-url-shortener
Social URL links redirect service powered by Cloudflare Workers and KV. Features customizable landing page, 404 status page for missing redirects, and one-click deploy!
https://github.com/0-vortex/cf-workers-url-shortener
Last synced: 9 days ago
JSON representation
Social URL links redirect service powered by Cloudflare Workers and KV. Features customizable landing page, 404 status page for missing redirects, and one-click deploy!
- Host: GitHub
- URL: https://github.com/0-vortex/cf-workers-url-shortener
- Owner: 0-vortex
- License: bsd-3-clause
- Created: 2021-03-05T02:02:28.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-04-27T05:02:26.000Z (over 3 years ago)
- Last Synced: 2024-05-20T20:39:11.625Z (6 months ago)
- Language: Handlebars
- Homepage: http://connect-with.vortex.name
- Size: 496 KB
- Stars: 27
- Watchers: 2
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# workers-url-shortener
[](http://commitizen.github.io/cz-cli/)
[](./LICENSE)
[](https://app.fossa.com/projects/git%2Bgithub.com%2F0-vortex%2Fworkers-url-shortener?ref=badge_shield)
[](https://codeclimate.com/github/0-vortex/workers-url-shortener/maintainability)
[](https://snyk.io/test/github/0-vortex/workers-url-shortener)
## Overview
A Cloudflare Workers script to use as a simple redirect system.
The [data.json](./src/data.json) file can be used as dummy input or ``git`` enabled backup for your production environment.
The motivation for doing such a thing is GUI or IAM enabled acces to these variables from other CloudFlare tools, essentially promoting observability.
## Folder structure
```
├──── workers-url-shortener
│ ├── .github/
│ ├── src/
│ ├── static/
│ ├── .editorconfig
│ ├── .eslintrc.js
│ ├── .gitattributes
│ ├── .gitignore
│ ├── .lintstagedrc.js
│ ├── .npmrc
│ ├── CODE_OF_CONDUCT.md
│ ├── LICENSE
│ ├── npm-shrinkwrap.json
│ ├── package.json
│ ├── README.md
│ └── wrangler.toml
```
## Deploy as Cloudflare Worker
I use this service for my profile at [github.com](https://github.com/0-vortex). Currently, the service is hosted on a free tier of [Cloudflare Workers](https://workers.cloudflare.com/) and limited at 100K requests per day.
Make sure to make the appropriate changes in [wrangler.toml](./wrangler.toml) first.
[](https://deploy.workers.cloudflare.com/?url=https://github.com/0-vortex/workers-url-shortener)
## Requirements
In order to run the project locally you need ``node>=14`` and ``npm>=6``.
### Install ``@cloudflare/wrangler``
Make sure you have the latest version of ``wrangler`` as described in [the wrangler docs](https://developers.cloudflare.com/workers/cli-wrangler/install-update).
#### Updating Wrangler with NPM:
```shell
npm uninstall -g @cloudflare/wrangler &&
npm install -g @cloudflare/wrangler
```
#### Install with cargo
```shell
cargo install wrangler --force
```
### Get a valid ``CF_API_TOKEN``
Make sure you have a valid deployment token by doing:
```shell
wrangler login
```
or:
```shell
wrangler config
```
### Generate a new repository
Create a new GitHub repository with the green button or clone:
```shell
# with git
git clone https://github.com/0-vortex/workers-url-shortener.git
```
or with [github-cli](https://cli.github.com):
```shell
# with github-cli
gh repo clone 0-vortex/workers-url-shortener
```
## Usage
### Configure KV
To successfully run the redirect worker we need to set up some KV namespaces.
Generate new `namespace_id`s for the KV keys it [wrangler.toml](./wrangler.toml) and follow the instructions:
```shell
# dev environment
wrangler kv:namespace create "REDIRECTS"
wrangler kv:namespace create "REDIRECTS" --preview
```
```shell
# production environment
wrangler kv:namespace create "REDIRECTS" --env production
wrangler kv:namespace create "REDIRECTS" --env production --preview
```
After you are done editing check if the changes are correct:
```shell
wrangler kv:namespace list
```
### Test data
Upload some data to the ``REDIRECTS`` namespace:
```shell
# dev environment
wrangler kv:bulk put --binding="REDIRECTS" ./src/data.json
wrangler kv:bulk put --binding="REDIRECTS" ./src/data.json --preview
```
```shell
# production environment
wrangler kv:bulk put --binding="REDIRECTS" ./src/data.json --env production
wrangler kv:bulk put --binding="REDIRECTS" ./src/data.json --env production --preview
```
### Local development
To develop locally just run:
```shell
npm start
```
To deploy to ``dev`` just run:
```shell
npm run deploy
```
### Monitoring
To monitor any of the deployed environments run:
```shell
wrangler tail
```
## License
This library is released under BSD-3 license clause.
[](https://app.fossa.com/projects/git%2Bgithub.com%2F0-vortex%2Fworkers-url-shortener?ref=badge_large)