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.

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](http://vercel.com/edge), [Upstash Redis](https://docs.upstash.com/redis), and [PlanetScale MySQL](https://planetscale.com/). Here are some of the features that Dub provides out-of-the-box: - [Built-in Analytics](#built-in-analytics) - [Custom Domains](#custom-domains) - [QR Code Generator](#qr-code-generator) - [OG Image Proxy](#og-image-proxy) ### Built-in Analytics Dub provides a powerful analytics dashboard for your links, including geolocation, device, and browser information. ![Analytics Dashboard](https://user-images.githubusercontent.com/28986134/200727883-40fe9e62-93a2-48b6-8316-4ce3e6f490f0.png) ### 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](https://domains-api.vercel.app/). ![Custom Domains](https://user-images.githubusercontent.com/28986134/200727913-432734b4-4fc7-46ef-b09f-cc8262dc8a0d.png) ### 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](https://user-images.githubusercontent.com/28986134/200727932-2259628b-8f89-4017-896d-a355940222db.png) ### 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](https://user-images.githubusercontent.com/28986134/200727958-e8a5ac24-644b-45c6-8018-41c4dea25cd1.gif) ## Deploy Your Own > Note: one-click deployment is a bit broken at the moment – you'll need to change some of the hard-coded values in the codebase to get it working. We're working on fixing this. 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](https://vercel.com/button)](https://dub.sh/deploy) ## Tech Stack - [Next.js](https://nextjs.org/) – framework - [Typescript](https://www.typescriptlang.org/) – language - [Tailwind](https://tailwindcss.com/) – CSS - [Upstash](https://upstash.com/) – redis - [Tinybird](https://tinybird.com/) – analytics - [PlanetScale](https://planetscale.com/) – database - [NextAuth.js](https://next-auth.js.org/) – auth - [Vercel](https://vercel.com/) – hosting - [Stripe](https://stripe.com/) – payments ## Implementation Dub is built as a standard Next.js application with [Middleware](https://nextjs.org/docs/advanced-features/middleware) to handle multi-tenancy, inspired by [the Vercel Platforms Starter Kit](https://github.com/vercel/platforms). [Redis](https://redis.io/) is used as the caching layer for all short links. [Clickhouse](https://clickhouse.com/) ([Tinybird](https://tinybird.com/)) is used as the analytics database for storing link click data. [MySQL](https://www.mysql.com/) is used as the database for storing user data, project data, and link metadata. You can refer to the Prisma schema [here](/prisma/schema.prisma). ## Contributing We love our contributors! Here's how you can contribute: - [Open an issue](https://github.com/steven-tey/dub/issues) if you believe you've encountered a bug. - Make a [pull request](https://github.com/steven-tey/dub/pull) to add new features/make quality-of-life improvements/fix bugs.

## Author - Steven Tey ([@steventey](https://twitter.com/steventey)) ## License Inspired by [Plausible](https://plausible.io/), Dub is open-source under the GNU Affero General Public License Version 3 (AGPLv3) or any later version. You can [find it here](https://github.com/steven-tey/dub/blob/main/LICENSE.md).