Skip to content

dyonc/dyo

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Dyo

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

Twitter License

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


Introduction

Dyo 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 Dyo provides out-of-the-box:

Built-in Analytics

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

Custom domains

You can easily configure custom domains on Dyo – 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.

Deploy Your Own

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

Deploy with Vercel

Tech Stack

Implementation

Dyo 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. dyo.at:clicks:github)
  • {domain}:root:clicks – sorted set of all root link clicks for a given domain (e.g. dyo.at: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.

License

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

About

Open-Source Link Shortener

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages