Customization Guide
Use this guide to keep Foundation code, adapt Example modules, enable Optional integrations, and label Coming Soon work honestly.
Your current setup
These values were written by the setup script and reflect how this project was configured. They are read-only here — re-run npm run setup to change them safely (it updates src/core/setup/generated.ts for you).
Core (default)
Start with the default baseline. You can opt into Advanced later without reinstalling.
Product Workspace
A clear public story with a credible working space behind it.
Launch checklist
IncludedA small starter checklist that makes the first-run path obvious and can be removed later if it stops being useful.
- Site Name
- next-foundry
- Site Description
- A clear public story with a credible working space behind it.
- OG Image URL
- Not set
What to keep as-is
These foundational pieces took significant effort to set up correctly. Keep them and build on top.
What to replace / customize
These are placeholders intentionally left generic. Replace them with your actual content.
src/components/layout/Header.tsx — Change "next-foundry" to your app namesrc/components/layout/Footer.tsx — Update copyright, links, social handlessrc/components/layout/Sidebar.tsx — Replace brand name and logo iconsrc/app/layout.tsx — Update metadata title and descriptionpublic/favicon.ico — Replace with your favicon
prisma/schema.prisma — Add your domain models (Post, Product, Order, etc.)prisma/seed.ts — Seed with realistic test data for your domainsrc/app/api/ — Add your own API routes and server actions
src/app/(dashboard)/dashboard/page.tsx — Replace mock stats with real datasrc/app/(dashboard)/dashboard/analytics/page.tsx — Hook up a real chart librarysrc/app/(dashboard)/dashboard/team/page.tsx — Pull team members from your databasesrc/app/(dashboard)/dashboard/profile/page.tsx — Load real user data from Clerk/DB
src/app/globals.css — Update the HSL CSS custom properties in :root and .darktailwind.config.mjs — Add custom Tailwind tokens if neededcomponents.json — Update the shadcn/ui base color if regenerating components
What to remove
These items exist for demonstration. Clean them up before launching your product.
const stats, recentActivity, teamMembers in dashboard/page.tsxconst projects in dashboard/projects/page.tsxconst apiKeys in dashboard/api-keys/page.tsx
src/app/(dashboard)/dashboard/analytics/ — Remove if not neededsrc/app/(dashboard)/dashboard/changelog/ — Remove if not neededsrc/app/(dashboard)/dashboard/notifications/ — Remove if not needed
npm uninstall gsap @gsap/reactDelete src/components/animations/ directoryReplace <FadeIn> with <div> and <StaggerChildren> with <div>
Delete src/app/(admin)/ directoryRemove admin links from Header.tsx and CommandPalette.tsx
src/app/page.tsx — Replace with your landing pagesrc/app/features/ — Delete or replace with your feature marketingsrc/app/customization/ — Delete (this page)src/app/docs/ — Replace with your product documentation
File structure overview
A bird's-eye view of the source directory to orient yourself quickly.
src/
├── app/
│ ├── (auth)/ # Unauthenticated layout
│ │ ├── sign-in/[[...sign-in]]/page.tsx
│ │ └── sign-up/[[...sign-up]]/page.tsx
│ ├── (dashboard)/ # Authenticated layout (Sidebar + Header)
│ │ ├── layout.tsx # Auth guard + sidebar layout
│ │ ├── loading.tsx # Shared dashboard loading skeleton
│ │ └── dashboard/
│ │ ├── page.tsx # /dashboard — overview
│ │ ├── analytics/ # /dashboard/analytics
│ │ ├── api-keys/ # /dashboard/api-keys
│ │ ├── changelog/ # /dashboard/changelog
│ │ ├── notifications/ # /dashboard/notifications
│ │ ├── profile/ # /dashboard/profile
│ │ ├── projects/ # /dashboard/projects
│ │ ├── settings/ # /dashboard/settings
│ │ └── team/ # /dashboard/team
│ ├── (admin)/ # Admin panel (authenticated)
│ │ ├── layout.tsx # Admin layout with admin sidebar
│ │ └── admin/
│ │ ├── page.tsx # /admin — overview
│ │ ├── users/ # /admin/users — user management
│ │ └── system/ # /admin/system — system health
│ ├── api/
│ │ └── webhooks/clerk/ # Clerk webhook receiver
│ ├── customization/ # /customization — this guide
│ ├── docs/ # /docs — documentation
│ ├── features/ # /features — feature reference
│ ├── layout.tsx # Root layout (Clerk, Providers)
│ ├── page.tsx # / — home / landing page
│ ├── error.tsx # Global error boundary
│ ├── loading.tsx # Root loading state
│ └── not-found.tsx # 404 page
├── components/
│ ├── animations/ # GSAP wrappers (FadeIn, StaggerChildren, etc.)
│ ├── layout/ # Header, Footer, Sidebar, MobileNav, etc.
│ ├── providers/ # Clerk + ThemeProvider wrapper
│ └── ui/ # shadcn/ui components
├── lib/
│ ├── db.ts # Prisma client singleton
│ └── utils.ts # cn() and other utilities
└── middleware.ts # Clerk auth middleware (route protection)Customization FAQ
Start customizing
Fork the repo and build your product on this foundation. Use the feature registry for clean removals, or customize manually. The stack is solid — the content is yours to replace.