dub README

The project's README from github.com/dubinc/dub. As one markdown file: README.md.

Dub is the modern, open-source link attribution platform for short links, conversion tracking, and affiliate programs.

Dub

The open-source link attribution platform.
Learn more »

Introduction · Tech Stack · Self-hosting · Contributing

Twitter Hacker News License


Introduction

Dub is the modern, open-source link attribution platform for short links, conversion tracking, and affiliate programs.

Our platform powers 100M+ clicks and 2M+ links monthly, and is used by world-class marketing teams from companies like Twilio, Buffer, Framer, Perplexity, Vercel, Laravel, and more.

Tech Stack

Self-Hosting

You can self-host Dub for greater control over your data and design. Read this guide to learn more.

Contributing

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

Package Version
node v23.11.0
pnpm 9.15.9

Common Local Development Issues

Dev Seed Script

This script seeds the database with development data for testing and development purposes.

Basic seeding (adds data without deleting existing data):

cd apps/web
pnpm run script dev/seed

Truncate database before seeding (deletes all existing data first):

cd apps/web
pnpm run script dev/seed --truncate

When using --truncate, the script will ask for confirmation before deleting any data.

Repo Activity

Dub repo activity – generated by Axiom

License

Dub Technologies, Inc. is a commercial open-source company, which means some parts of this open-source repository require a commercial license. The concept is called "Open Core" where the core technology (99%) is fully open source, licensed under AGPLv3 and the last 1% is covered under a commercial license ("/ee" Enterprise Edition) which we believe is entirely relevant for larger organisations that require enterprise features. Enterprise features are built by the core engineering team of Dub Technologies, Inc., which is hired full-time.

dub (dubinc/dub)

Searching Database…

24.9K ·GitHub
Что это такое?Платформа с открытым кодом для атрибуции ссылок: короткие ссылки, отслеживание конверсий и партнёрские программы. Ежемесячно через неё проходит более 100 миллионов переходов и более 2 миллионов ссылок у таких команд, как Twilio, Buffer, Framer и Perplexity.
Это облачный сервис, в котором я регистрируюсь, или что-то, что я разворачиваю сам?И то и другое. Есть облачная платформа для маркетинговых команд, а тот же самый код можно развернуть у себя, если нужен больший контроль над данными и оформлением — в README есть ссылка на инструкцию по самостоятельному развёртыванию.
Как запустить локальную копию для разработки?Склонируйте монорепозиторий Turborepo, выполните pnpm install, затем pnpm dev. Придерживайтесь рекомендованных версий: node v23.11.0 и pnpm 9.15.9.
От каких внешних сервисов зависит проект?Он работает на Next.js + TypeScript с Prisma поверх PlanetScale (MySQL), плюс Upstash Redis, аналитика Tinybird, аутентификация NextAuth.js, BoxyHQ для SAML/SSO, платежи через Stripe, письма через Resend и развёртывание на Vercel.
Что чаще всего ломается при настройке локального окружения для разработки?Две известные проблемы: отсутствующая таблица — лечится запуском pnpm prisma:push, и падающая сборка из-за несовпадающих версий node/pnpm — установите рекомендованные версии, удалите node_modules, .next и .turbo, затем поставьте зависимости и пересоберите проект.
Ею правда можно пользоваться бесплатно, или часть под платной подпиской?Это open core: 99% кода бесплатно под лицензией AGPLv3, а оставшийся 1% — Enterprise Edition в папке /ee — требует коммерческой лицензии и включает корпоративные возможности, которые разрабатывает штатная команда Dub.
Как наполнить локальный экземпляр тестовыми данными?Есть сид-скрипт для разработки, который заполняет базу тестовыми данными. Обычный сидинг только добавляет данные, ничего не удаляя; запустите его с флагом --truncate, чтобы сначала очистить базу — перед удалением он попросит подтверждение.
Могут ли сотрудники моей компании входить через SAML SSO?Аутентификация работает через NextAuth.js, а в стеке есть BoxyHQ для SAML/SSO, то есть единый вход корпоративного уровня — часть платформы.
Есть ли в проекте CLI?Да — в монорепозитории есть пакет @dub/cli, который публикуется в npm; скрипт publish-cli собирает его с помощью turbo и выкладывает в реестр.
Creator
dubinc
Size
92.2 MB
Stars
24.9K
Updated
CommitOct 16
Age
4y
Commits · 90 Days