first

config/index.ts

@@ -0,0 +1,167 @@
+import type { Config } from "./types";
+
+export const config = {
+	appName: "supastarter for Next.js Demo",
+	// Internationalization
+	i18n: {
+		// Whether internationalization should be enabled (if disabled, you still need to define the locale you want to use below and set it as the default locale)
+		enabled: true,
+		// Define all locales here that should be available in the app
+		// You need to define a label that is shown in the language selector and a currency that should be used for pricing with this locale
+		locales: {
+			en: {
+				currency: "USD",
+				label: "English",
+			},
+			de: {
+				currency: "USD",
+				label: "Deutsch",
+			},
+		},
+		// The default locale is used if no locale is provided
+		defaultLocale: "en",
+		// The default currency is used for pricing if no currency is provided
+		defaultCurrency: "USD",
+		// The name of the cookie that is used to determine the locale
+		localeCookieName: "NEXT_LOCALE",
+	},
+	// Organizations
+	organizations: {
+		// Whether organizations are enabled in general
+		enable: true,
+		// Whether billing for organizations should be enabled (below you can enable it for users instead)
+		enableBilling: true,
+		// Whether the organization should be hidden from the user (use this for multi-tenant applications)
+		hideOrganization: false,
+		// Should users be able to create new organizations? Otherwise only admin users can create them
+		enableUsersToCreateOrganizations: true,
+		// Whether users should be required to be in an organization. This will redirect users to the organization page after sign in
+		requireOrganization: false,
+		// Define forbidden organization slugs. Make sure to add all paths that you define as a route after /app/... to avoid routing issues
+		forbiddenOrganizationSlugs: [
+			"new-organization",
+			"admin",
+			"settings",
+			"ai-demo",
+			"organization-invitation",
+		],
+	},
+	// Users
+	users: {
+		// Whether billing should be enabled for users (above you can enable it for organizations instead)
+		enableBilling: true,
+		// Whether you want the user to go through an onboarding form after signup (can be defined in the OnboardingForm.tsx)
+		enableOnboarding: true,
+	},
+	// Authentication
+	auth: {
+		// Whether users should be able to create accounts (otherwise users can only be by admins)
+		enableSignup: true,
+		// Whether users should be able to sign in with a magic link
+		enableMagicLink: true,
+		// Whether users should be able to sign in with a social provider
+		enableSocialLogin: true,
+		// Whether users should be able to sign in with a passkey
+		enablePasskeys: true,
+		// Whether users should be able to sign in with a password
+		enablePasswordLogin: true,
+		// Whether users should be activate two factor authentication
+		enableTwoFactor: true,
+		// where users should be redirected after the sign in
+		redirectAfterSignIn: "/app",
+		// where users should be redirected after logout
+		redirectAfterLogout: "/",
+		// how long a session should be valid
+		sessionCookieMaxAge: 60 * 60 * 24 * 30,
+	},
+	// Mails
+	mails: {
+		// the from address for mails
+		from: "noreply@supastarter.dev",
+	},
+	// Frontend
+	ui: {
+		// the themes that should be available in the app
+		enabledThemes: ["light", "dark"],
+		// the default theme
+		defaultTheme: "light",
+		// the saas part of the application
+		saas: {
+			// whether the saas part should be enabled (otherwise all routes will be redirect to the marketing page)
+			enabled: true,
+			// whether the sidebar layout should be used
+			useSidebarLayout: true,
+		},
+		// the marketing part of the application
+		marketing: {
+			// whether the marketing features should be enabled (otherwise all routes will be redirect to the saas part)
+			enabled: true,
+		},
+	},
+	// Storage
+	storage: {
+		// define the name of the buckets for the different types of files
+		bucketNames: {
+			avatars: process.env.NEXT_PUBLIC_AVATARS_BUCKET_NAME ?? "avatars",
+		},
+	},
+	contactForm: {
+		// whether the contact form should be enabled
+		enabled: true,
+		// the email to which the contact form messages should be sent
+		to: "hello@your-domain.com",
+		// the subject of the email
+		subject: "Contact form message",
+	},
+	// Payments
+	payments: {
+		// define the products that should be available in the checkout
+		plans: {
+			// The free plan is treated differently. It will automatically be assigned if the user has no other plan.
+			free: {
+				isFree: true,
+			},
+			pro: {
+				recommended: true,
+				prices: [
+					{
+						type: "recurring",
+						productId: process.env
+							.NEXT_PUBLIC_PRICE_ID_PRO_MONTHLY as string,
+						interval: "month",
+						amount: 29,
+						currency: "USD",
+						seatBased: true,
+						trialPeriodDays: 7,
+					},
+					{
+						type: "recurring",
+						productId: process.env
+							.NEXT_PUBLIC_PRICE_ID_PRO_YEARLY as string,
+						interval: "year",
+						amount: 290,
+						currency: "USD",
+						seatBased: true,
+						trialPeriodDays: 7,
+					},
+				],
+			},
+			lifetime: {
+				prices: [
+					{
+						type: "one-time",
+						productId: process.env
+							.NEXT_PUBLIC_PRICE_ID_LIFETIME as string,
+						amount: 799,
+						currency: "USD",
+					},
+				],
+			},
+			enterprise: {
+				isEnterprise: true,
+			},
+		},
+	},
+} as const satisfies Config;
+
+export type { Config };

config/package.json

@@ -0,0 +1,11 @@
+{
+	"devDependencies": {
+		"@repo/tsconfig": "workspace:*"
+	},
+	"name": "@repo/config",
+	"private": true,
+	"scripts": {
+		"type-check": "tsc --noEmit"
+	},
+	"version": "0.0.0"
+}

config/tsconfig.json

@@ -0,0 +1,3 @@
+{
+	"extends": "@repo/tsconfig/base.json"
+}

config/types.ts

@@ -0,0 +1,86 @@
+export type Config = {
+	appName: string;
+	i18n: {
+		enabled: boolean;
+		locales: { [locale: string]: { currency: string; label: string } };
+		defaultLocale: string;
+		defaultCurrency: string;
+		localeCookieName: string;
+	};
+	organizations: {
+		enable: boolean;
+		enableBilling: boolean;
+		enableUsersToCreateOrganizations: boolean;
+		requireOrganization: boolean;
+		hideOrganization: boolean;
+		forbiddenOrganizationSlugs: string[];
+	};
+	users: {
+		enableBilling: boolean;
+		enableOnboarding: boolean;
+	};
+	auth: {
+		enableSignup: boolean;
+		enableMagicLink: boolean;
+		enableSocialLogin: boolean;
+		enablePasskeys: boolean;
+		enablePasswordLogin: boolean;
+		enableTwoFactor: boolean;
+		redirectAfterSignIn: string;
+		redirectAfterLogout: string;
+		sessionCookieMaxAge: number;
+	};
+	mails: {
+		from: string;
+	};
+	storage: {
+		bucketNames: {
+			avatars: string;
+		};
+	};
+	ui: {
+		enabledThemes: Array<"light" | "dark">;
+		defaultTheme: Config["ui"]["enabledThemes"][number];
+		saas: {
+			enabled: boolean;
+			useSidebarLayout: boolean;
+		};
+		marketing: {
+			enabled: boolean;
+		};
+	};
+	contactForm: {
+		enabled: boolean;
+		to: string;
+		subject: string;
+	};
+	payments: {
+		plans: {
+			[id: string]: {
+				hidden?: boolean;
+				isFree?: boolean;
+				isEnterprise?: boolean;
+				recommended?: boolean;
+				prices?: Array<
+					{
+						productId: string;
+						amount: number;
+						currency: string;
+						hidden?: boolean;
+					} & (
+						| {
+								type: "recurring";
+								interval: "month" | "year" | "week";
+								intervalCount?: number;
+								trialPeriodDays?: number;
+								seatBased?: boolean;
+						  }
+						| {
+								type: "one-time";
+						  }
+					)
+				>;
+			};
+		};
+	};
+};