Quick Start | blade47/dub Wiki | doc0

Public

Quick Start | blade47/dub Wiki | doc0

Pipeline Task	Task Dependencies (`dependsOn`)	Persistent (`persistent`)	Cache Enabled (`cache`)	Output Paths / Behavior (`outputs`)
`build`	`["^build"]`	false (default)	true (default)	`["!.next/cache/", ".next/", "dist/**"]`
`dev`	None	`true`	`false`	None (persistent server process)
`clean`	None	false	`false`	None (removes build artifacts)
`test`	`["^build"]`	false (default)	true (default)	None

Script Name	Command Execution String	Purpose
`dev`	`pnpm prisma:generate && concurrently --kill-others "next dev --turbopack --port 8888"`	Generates Prisma client and starts Next.js dev server with Turbopack on port 8888
`build`	`pnpm prisma:generate && next build`	Generates Prisma client and runs production Next.js build
`lint`	`next lint`	Executes Next.js linter checks
`start`	`next start`	Starts production Next.js server instance
`script`	`tsx ./scripts/run.ts`	Executes arbitrary TypeScript scripts via `tsx`
`test`	`pnpm prisma:generate && vitest -no-file-parallelism --bail=1`	Runs Vitest test suite with zero file parallelism and fails on first error
`test:e2e`	`playwright test`	Executes Playwright end-to-end tests
`test:e2e:ui`	`playwright test --ui`	Opens Playwright UI runner for end-to-end tests
`test:e2e:headed`	`playwright test --headed`	Runs Playwright end-to-end tests in headed browser mode
`generate-openapi`	`tsx ./scripts/generate-openapi.ts`	Generates OpenAPI specification artifacts
`prisma:generate`	`dotenv-flow -e .env -- prisma generate --schema=./prisma/schema`	Generates Prisma client from schema using environment variables
`prisma:push`	`dotenv-flow -e .env -- prisma db push --schema=./prisma/schema`	Pushes Prisma schema state directly to database without migrations
`prisma:studio`	`dotenv-flow -e .env -- prisma studio --schema=./prisma/schema --browser none`	Launches Prisma Studio GUI without spawning an automatic browser window
`prisma:format`	`dotenv-flow -e .env -- prisma format --schema=./prisma/schema`	Formats Prisma schema files

export const LOCALHOST_GEO_DATA = {
  continent: "NA",
  country: "US",
  city: "San Francisco",
  region: "CA",
  latitude: "37.7695",
  longitude: "-122.385",
};
export const LOCALHOST_IP = "63.141.57.109";

Service Name	Image	Host Ports	Container Ports	Dependencies / Links	Purpose
`ps-mysql`	`mysql:8.0`	`3306:3306`	`3306`	None (Volume: `ps-mysql`)	MySQL 8.0 server instance configured with native passwords, an empty root password, and a default database named `planetscale`.
`planetscale-proxy`	`ghcr.io/mattrobenolt/ps-http-sim:latest`	`3900:3900`	`3900`	`ps-mysql` (depends_on, links)	PlanetScale HTTP simulator proxying requests to the MySQL backend without authentication on port 3900.
`mailhog`	`mailhog/mailhog:latest`	`1025:1025`, `8025:8025`	`1025`, `8025`	None	Local email testing service capturing SMTP traffic on port 1025 with a web dashboard exposed on port 8025.

Seed Field	Target Entity / Type	Key Properties	Purpose
`workspace`	`Project`	`id`, `name`, `slug`, `plan`, `usageLimit`, `defaultProgramId`	Defines the primary enterprise tenant entity (`Acme, Inc.`) with strict feature limits and configuration flags. Sources: apps/web/scripts/dev/seed.ts:24-48, apps/web/scripts/dev/data.json:2-25
`users`	`User` & `ProjectUsers`	`id`, `name`, `email`, `emailVerified`, `role`	Provisions internal test accounts with distinct workspace access roles (`owner`, `member`, `viewer`, `billing`). Sources: apps/web/scripts/dev/seed.ts:106-110, apps/web/scripts/dev/data.json:26-55
`domains`	`Domain`	`id`, `slug`, `verified`	Registers verified routing domains such as `dub.sh` under the workspace. Sources: apps/web/scripts/dev/seed.ts:50, apps/web/scripts/dev/data.json:56-62
`emailDomains`	`EmailDomain`	`id`, `slug`, `status`	Configures verified email domains such as `getacme.link`. Sources: apps/web/scripts/dev/seed.ts:52, apps/web/scripts/dev/data.json:63-69
`folders`	`Folder`	`id`, `name`, `description`, `accessLevel`	Sets up default link organization folders with specific access levels. Sources: apps/web/scripts/dev/seed.ts:54, apps/web/scripts/dev/data.json:70-77
`rewards`	`Reward`	`id`, `groupId`, `event`, `type`, `amountInCents`, `maxDuration`	Establishes payout rules for conversion events such as flat lead and sale bonuses. Sources: apps/web/scripts/dev/seed.ts:56-68, apps/web/scripts/dev/data.json:78-99
`groups`	`PartnerGroup`	`id`, `name`, `slug`, `leadRewardId`, `saleRewardId`, `defaultLinks`	Categorizes partners into commission tiers with custom domain validation and default link payloads. Sources: apps/web/scripts/dev/seed.ts:70-81, apps/web/scripts/dev/data.json:100-123
`program`	`Program`	`id`, `name`, `slug`, `defaultFolderId`, `defaultGroupId`, `domain`	Defines the referral program settings linking folders, groups, and domains. Sources: apps/web/scripts/dev/seed.ts:83-104, apps/web/scripts/dev/data.json:124-136
`partners`	`Partner`	`id`, `name`, `email`, `country`, `user`	Generates affiliated partner profiles tied to individual user accounts. Sources: apps/web/scripts/dev/seed.ts:111-119, apps/web/scripts/dev/data.json:137-181

Referral Source Constant	Domain Value
`direct`	Direct traffic or bookmark
`linkedin.com`	Professional network referral
`twitter.com`	Social media link
`marketplace`	Internal marketplace discovery
`acme.com`	Corporate domain referral
`google.com`	Search engine referral

const commissions: Prisma.CommissionCreateManyInput[] = [
  {
    id: createId({ prefix: "cm_" }),
    programId,
    partnerId,
    type: "referral",
    amount: 0,
    quantity: 1,
    earnings: 10000,
    createdAt: new Date(),
  },
  {
    id: createId({ prefix: "cm_" }),
    programId,
    partnerId,
    type: "referral",
    amount: 0,
    quantity: 1,
    earnings: 20000,
    createdAt: new Date(),
  },
];
 
await prisma.commission.createMany({
  data: commissions,
  skipDuplicates: true,
});

Field	Value	Purpose
`id`	`GOOGLE_ADS_INTEGRATION_ID`	Primary integration identifier constant
`name`	`"Google Ads"`	Human-readable display name
`slug`	`"google-ads"`	URL-safe routing slug
`description`	`"Upload offline click conversions to Google Ads to optimize ad performance."`	Provider overview text
`developer`	`"Dub"`	Entity maintaining the integration
`website`	`"https://ads.google.com"`	Official external provider URL
`verified`	`true`	Official verification status flag
`projectId`	`DUB_WORKSPACE_ID`	Owning workspace context
`category`	`"Analytics"`	Functional taxonomy grouping

await prisma.installedIntegration.upsert({
  where: {
    userId_integrationId_projectId: {
      userId: "cl7p1s07k000687rbuhpwqkqa",
      integrationId: INTERCOM_INTEGRATION_ID,
      projectId: ACME_WORKSPACE_ID,
    },
  },
  create: {
    userId: "cl7p1s07k000687rbuhpwqkqa",
    integrationId: INTERCOM_INTEGRATION_ID,
    projectId: ACME_WORKSPACE_ID,
    credentials: {
      appId: "xxx",
      accessToken: encrypt("xxx"),
    },
  },
  update: {
    //
  },
});

Parameter / Constant	Value / Default	Purpose
`DEFAULT_COUNT`	`100_000`	Default number of partner records to generate
`MAX_COUNT`	`1_000_000`	Upper limit restriction for bulk generation
`DEFAULT_SEED`	`"partners-search"`	Base seed string for deterministic generation
`CHUNK_SIZE`	`2_500`	Atomic transaction block size for batch database inserts
`LOCAL_DATABASE_HOSTS`	`localhost`, `127.0.0.1`, `0.0.0.0`, `::1`, `host.docker.internal`, `mysql`, `db`	Permitted hosts for local database connection safety checks

async function* iterateProgramIds(afterProgram?: string) {
  let cursor = afterProgram;
  let inclusive = Boolean(afterProgram);
 
  while (true) {
    const programs = await prisma.program.findMany({
      where: cursor ? { id: inclusive ? { gte: cursor } : { gt: cursor } } : {},
      select: { id: true },
      orderBy: { id: "asc" },
      take: PROGRAM_PAGE_SIZE,
    });
 
    if (programs.length === 0) {
      return;
    }
 
    for (const { id } of programs) {
      yield id;
    }
 
    cursor = programs[programs.length - 1].id;
    inclusive = false;
 
    if (programs.length < PROGRAM_PAGE_SIZE) {
      return;
    }
  }
}

const EMOJIBASE_DATA_URL =
  "https://cdn.jsdelivr.net/npm/emojibase-data@16.0.3/en/data.json";
const UPSERT_BATCH_SIZE = 500;
 
type EmojiVectorRecord = {
  id: string;
  data: string;
  metadata: {
    emoji: string;
    label: string;
  };
};

Benchmark Configuration Flag	Default Value	Limit / Constraint	Purpose
`--requests`	`1,000`	Minimum: `1,000`	Total request count for latency percentile calculation
`--warmup`	`50`	Non-negative integer	Initial unmeasured warmup request iterations
`--concurrency`	`10`	Cannot exceed `--requests`	Parallel execution concurrency bound
`--pageSize`	`25`	Maximum: `PARTNER_SEARCH_CANDIDATE_LIMIT`	Result pagination size per query
`--thresholdMs`	`1,000`	Positive integer	Maximum acceptable p99 latency threshold
`--sampleSize`	`100`	Max: `1,000` (`10,000` with `--searchOnly`)	Partner sampling count across the program index
`--maxErrorRate`	`0`	0 to 100 percentage	Maximum allowable request error rate percentage