dub - An open-source link shortener with built-in analytics + free custom domains.

Created at: 2022-08-28 06:15:11
Language: TypeScript
License: AGPL-3.0
Dub – an open-source link management tool for modern marketing teams to create, share, and track short links.

Dub

An open-source link management tool for modern marketing teams to create, share, and track short links.

Twitter Hacker News License

Introduction · Deploy Your Own · Tech Stack · Implementation · Contributing


Introduction

Dub is an open-source link management tool for modern marketing teams to create, share, and track short links. Built with Vercel Edge Functions, Upstash Redis, and Planetscale MySQL.

Here are some of the features that Dub provides out-of-the-box:

Built-in Analytics

Dub provides a powerful analytics dashboard for your links, including geolocation, device, and browser information.

Analytics Dashboard

Custom domains

You can easily configure custom domains on Dub – just add an A/CNAME record to your DNS provider and you're good to go. This is built on the Vercel Domains API.

Custom Domains

QR Code Generator

You can easily generate and customize QR codes for your links, which can be used for flyers, posters, powerpoint presentations, etc.

QR Code

OG Image Proxy

Add a custom OG image in front of your target URL. Bots like Twitter/Facebook will be served this image, while users will be redirected to your target URL.

OG Image Proxy

Deploy Your Own

You can deploy your own hosted version of Dub for greater privacy & control. Just click the link below to deploy a ready-to-go version of Dub to Vercel.

Deploy with Vercel

Tech Stack

Implementation

Dub is built as a standard Next.js application with Middleware to handle multi-tenancy, inspired by the Vercel Platforms Starter Kit.

Redis is used as the caching layer for all short links. Redis also has the Sorted Set data type, which is perfect for storing & retrieving time-series analytics data. Here's the full schema:

  • {domain}:{key} – string containing a JSON object with the target URL and password (optional). Also has an optional TTL.
  • {domain}:clicks:{key} – sorted set of all clicks for a given link (e.g. dub.sh:clicks:github)
  • {domain}:root:clicks – sorted set of all root link clicks for a given domain (e.g. dub.sh:root:clicks)

MySQL is used as the database for storing user data, project data, and link metadata. You can refer to the Prisma schema here.

Contributing

We love our contributors! Here's how you can contribute:

  • Open an issue if you believe you've encountered a bug.
  • Make a pull request to add new features/make quality-of-life improvements/fix bugs.

Author

License

Inspired by Plausible, Dub is open-source under the GNU Affero General Public License Version 3 (AGPLv3) or any later version. You can find it here.