Skip to content
Documentation

Set Up a Website Kit

A Website Kit is a complete multipage Next.js website. You get the whole project as a GitHub repository, so there is nothing to install with the shadcn CLI.

Already own Pro?

Every Website Kit is included with Individual Pro, including Pro purchases made before Website Kits launched. You do not need to buy kits separately.

Your existing Pro registry key keeps working.

  1. 1. Get your own copy

    You need Node.js⁠ (opens in a new tab) 24 or newer, pnpm⁠ (opens in a new tab) 12 or newer and a GitHub account. Kit source and updates are delivered through Read access to the kit's private GitHub repository.

    Open your Polar customer portal⁠ (opens in a new tab), connect GitHub and accept the repository invitation. Then open the kit repository and click Use this template to create a private repository of your own, then clone it:

    Terminal

    git clone https://github.com/your-account/your-site.git
    cd your-site
  2. 2. Install and run it

    Terminal

    pnpm install
    pnpm dev

    Open http://localhost:3000. You should see the kit's demo website, running from your own files.

  3. 3. Set your name and brand

    Each kit's README.md lists its exact files. Start in src/config/site.ts. Page titles, meta descriptions and structured data read from it. Keep the fields the file already has and replace their values:

    src/config/site.ts (example)

    export const siteConfig = {
      name: 'Your Company',
      title: 'Your Headline',
      description: 'One or two sentences about what you do.',
    } as const

    Then replace the logo component in src/components/, the icons in src/app/ and the brand files in public/brand/. Colors and the typeface are set in src/app/globals.css and src/app/layout.tsx. Some kits also use src/app/kit.css; check the kit's README.

  4. 4. Edit the pages and blog

    Pages
    One folder per page in src/app/. To add one, copy a similar folder and add its path to PAGES in src/app/sitemap.ts.
    Copy
    At the top of each section's file in src/components/, so you can rewrite a page without touching its layout.
    Blog and collections
    MDX files in src/posts/ (and src/work/ or src/docs/, depending on the kit). To publish a post, add the file and an entry with the same slug to the list in src/lib/posts.ts.
    Demo content
    Every company, quote, portrait and product image is invented for the kit, and the legal pages in src/legal/ are written for a fictional company. Replace them before you publish.

    A few names differ between kits. Each kit's README.md lists its exact paths, and DESIGN.md explains the design so you or a coding agent can add pages that match.

  5. 5. Connect the forms

    The contact, signup and newsletter forms are demo interfaces. No submission service is included. Connect them to your own form backend, CRM or API route before collecting submissions; an unconnected form may only reload the page. Search the project for <form and give each form an action or a submit handler.

  6. 6. Check and publish

    Stop pnpm dev, then run the kit's checks. They cover every page in your sitemap: head tags, links, layout, speed and accessibility.

    On the first run, install the browser dependencies with pnpm exec playwright install. Lighthouse also needs Chrome installed on your machine.

    Terminal

    pnpm test
    pnpm test:e2e
    pnpm lighthouse

    The site is static and runs on any host that serves a Next.js build. Set two environment variables on the host; both are read at build time:

    SITE_URL
    Your public origin, such as https://example.com, for canonicals, the sitemap and structured data. On Vercel it defaults to the production domain.
    SITE_ENV
    Set to production on hosts other than Vercel so the site is indexed. Any other value, such as staging, keeps a deploy out of search.

Good to know

  • A kit is the marketing website only. It has no backend, CMS, authentication, billing or payment service, and the product or app shown in a demo is not included.
  • A kit is a shadcn/ui project on Base UI with the 7Ovr registries already in components.json, so blocks install into it as usual. Pro blocks need Pro setup; a single-kit purchase does not include the Pro registry.
  • Your copy does not change when a kit is updated. Updates appear in the original kit repository. Compare the changed files and copy the updates you want into your project. A project created with "Use this template" has its own Git history. The license has the full terms.