An open API service indexing awesome lists of open source software.

https://github.com/vanityurls/code

Cloudflare Workers redirector for running a branded short-link domain as code
https://github.com/vanityurls/code

all-contributors bitly cli cloudflare cloudflare-pages link-shortener short-link short-links shorten-urls shortener shortlink shortlinks url-shortener url-shortner urlshortener

Last synced: 9 days ago
JSON representation

Cloudflare Workers redirector for running a branded short-link domain as code

Awesome Lists containing this project

README

          

![logo](.github/banner.png)

[![License](https://img.shields.io/github/license/vanityURLs/code?style=flat-square&labelColor=111827&color=0F766E)](LICENSE)
[![Release](https://img.shields.io/github/v/release/vanityURLs/code?style=flat-square&labelColor=111827&color=0F766E)](https://github.com/vanityURLs/code/releases/latest)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-0F766E?style=flat-square&labelColor=111827)](.github/CODE_OF_CONDUCT.md)
[![All Contributors](https://img.shields.io/badge/all_contributors-4-0F766E?style=flat-square&labelColor=111827)](#contributors)

vanityURLs is a Cloudflare Workers redirector for running a branded short-link domain as code. Links, schedules,
destination policies, localized instance pages, and operator configuration live in Git; the build produces the Worker
assets that Cloudflare deploys.

The [documentation](https://vanityurls.link/en/docs/setup/) on the website is the source of truth for setup and
operations.

## Quickstart

Before starting, you need a registered short domain, GitHub and Cloudflare accounts, Git, Node.js 20 or newer, npm, and
a text editor. The short domain must use Cloudflare as its authoritative DNS provider before the Worker can serve it.

Follow the [documentation](https://vanityurls.link/en/docs/quickstart) to spin your vanityURLs' instance.

## Contributions

[Contributions](.github/CONTRIBUTING.md) are welcome! We recognize
[all types](https://allcontributors.org/docs/en/emoji-key) based on the
[all-contributors](https://github.com/all-contributors/all-contributors) specification. Please note that this project is
released with a [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md). By participating in this project you agree to
abide by its terms.



Benoît H. Dicaire
Benoît H. Dicaire

💻 📖 🛡️
Brian J. Adams
Brian J. Adams

🤔 📓
Félix Léger
Félix Léger

🤔 📓 📣
Jake Edwards
Jake Edwards

📖
Tiago Serafim
Tiago Serafim

💻

## Related

- [dnsConfiguration](https://github.com/bhdicaire/dnsConfiguration) – Automated DNS configuration with StackOverflow's
DNSControl and Git

## Licence

**vanityURLs** is Copyright 2023 Benoît H. Dicaire and
[licensed under the MIT licence](https://github.com/vanityurls/code/blob/main/LICENSE).