How kevinkoosk/dubsh works
Project type and purpose
• Dub is a full‑stack, multi‑tenant SaaS web application: an open‑source link shortener with built‑in analytics, custom domains, QR code generation, and payment/subscription management.
• Built on Next.js (React), deployed on Vercel, using Edge Functions for link redirects/stats, serverless API routes for data operations, Redis (Upstash) as a caching/time‑series store, and MySQL (PlanetScale via Prisma) for core persistent data.
Key architectural components
A. Client (Browser / Mobile)
• Next.js React UI (pages in pages/app, pages/home, components/…)
• Tailwind CSS for styling
B. Edge Layer (Vercel Edge Functions)
• Fast redirects, analytics increments, OG image proxy, title fetching (under pages/api/edge/…)
• Bypasses full serverless API for performance-critical link resolution
C. Serverless API Layer (Vercel Serverless Functions)
• Auth (NextAuth.js), user/project/link CRUD, domain management, invitations, stats queries, Stripe endpoints (under pages/api/…)
• Middleware (middleware.ts, lib/middleware/…) handles multi‑tenant routing (domain → project)
D. Background/CRON Jobs
• Scheduled tasks (lib/cron, pages/api/cron/…) for domain verification, usage aggregation
E. Data Stores
1. Redis (Upstash)
– Caching of link → target mapping ({domain}:{key})
– Sorted sets for time‑series analytics ({domain}:clicks:{key}, {domain}:root:clicks)
2. MySQL (PlanetScale via Prisma)
– Persistent storage of users, projects, link metadata, domain configs, subscription records
F. External Services
• Stripe – payment, subscription management (lib/stripe, pages/api/stripe/…)
• Vercel Domains API – custom domain provisioning (pages/api/projects/[slug]/domains/…)
• Email Provider – transactional emails (welcome, invites) via Next.js email templates (emails/…)
• Upstash CRON – optional Redis scheduled tasks if used
G. Utilities & Libraries
• lib/qr – QR code generation
• lib/twitter – OG/twitter card fetching
• lib/hooks, lib/utils – shared hooks/helpers
Relationships & data flows
1. User → Next.js frontend (SSG/SSR/CSR)
2. Frontend → Serverless API → MySQL (via Prisma) for CRUD (users, projects, links, domains)
3. Frontend → Serverless API → Redis for quick usage/analytics data retrieval
4. External Stripe requests → Serverless API → Stripe SDK → MySQL update
5. Client clicks a short link (ex. https://mydomain.com/abc) → Vercel Edge Function
• Edge Function reads mapping from Redis (falls back to MySQL via serverless API if miss)
• Logs click to Redis sorted set
• Redirects to target URL
6. Cron jobs periodically reconcile/cache or verify domain statuses
7. Notifications/emails triggered by serverless functions using email templates
Architectural patterns / design principles
• Multi‑tenant routing using Next.js Middleware – domain‑based tenant resolution
• CQRS‑like split: Edge functions handle read‑heavy, latency‑sensitive link resolution; serverless APIs handle writes/CUD
• Cache‑aside pattern for Redis (hot link metadata in Redis, fallback to primary store)
• Micro‑frontend‐style directory separation: components/app vs. components/home vs. components/shared
• Separation of concerns: UI → API → Data → External integrations
Detail
• Critical components: middleware, edge vs. serverless, scheduled jobs
• Multi‑tenant design: illustrate domain routing via Middleware
• Caching strategy: Redis as first‑look store for link metadata/analytics