Dub

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

Introduction · Local Development · 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
• Custom Domains
• QR Code Generator
• OG Image Proxy

Built-in Analytics

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

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.

QR Code Generator

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

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.

Local Development

To develop Dub locally, you will need to clone this repository and set up all the env vars outlined in the .env.example file.

Once that's done, you can use the following commands to run the app locally:

yarn
yarn build
yarn dev

We're planning to add a proper, well-documented self-hosting guide for Dub soon – stay tuned!

Tech Stack

• Next.js – framework
• Typescript – language
• Tailwind – CSS
• Upstash – redis
• Tinybird – analytics
• PlanetScale – database
• NextAuth.js – auth
• BoxyHQ – SSO/SAML
• Vercel – hosting
• Stripe – payments

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.

Clickhouse (Tinybird) is used as the analytics database for storing link click data.

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.

Repo Activity

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.