Kernlift

Rebrand the project

Replace the Kernlift name, URL, description, icons and share image with your own, and choose where people land after signing in.

A new project still shows the Kernlift name in its header, browser tab, emails and share cards. Site identity is set in one file, src/config/site.ts. The rest of this guide covers the places that file does not cover: the page titles in the message dictionaries, the generated artwork and the sender name.

Before you begin

  • A project that runs locally with pnpm dev. See Quick start.
  • Your product name, a one-sentence description and the production domain.
  • Optional: your own logo as an SVG, and a 1200×630 share image.

Set the site identity

Edit src/config/site.ts

src/config/site.ts
export const siteConfig = {
  name: "Acme",
  shortName: "Acme",
  url: normalizeOrigin(process.env.SITE_URL ?? "https://acme.com"),
  description: "One sentence that says what Acme does.",
  ogImage: "/og-default.png",
  locale: "en",
  themeColor: "#3859D6",
  backgroundColor: "#F6F5F1",
  twitter: { site: "", card: "summary_large_image" },
} as const;
FieldUsed by
nameThe public header and footer, the auth pages, the workspace sidebar, system pages, the email shell, og:site_name, the feed title and the web manifest
shortNameshort_name in /manifest.webmanifest
urlCanonical links, og:url, the sitemap, robots.txt, the feed and absolute links in email
descriptionThe fallback meta description, the feed and the manifest
ogImageThe fallback og:image and twitter:image, relative to url
themeColor, backgroundColorThe theme-color meta tag and the manifest
twitter.sitetwitter:site; leave it empty to omit the tag

A fresh clone still carries the template's own name, shortName and url; change all three.

Set the production origin

SITE_URL overrides siteConfig.url at runtime, so one build can serve a preview domain and the production domain. Set it wherever the app runs:

.env
SITE_URL=https://acme.com

A trailing slash is not needed, because the config strips it. OAuth callbacks and auth email links use the Base URL at /admin/config/auth instead. It is seeded from the site address on first start; change it there if the domain changes. See Environment variables.

Replace the default titles in both dictionaries

The site-wide default title and the home page title are copy, so they live in the message dictionaries, not in site.ts. Edit the same keys in src/i18n/locales/en/messages.ts and src/i18n/locales/zh/messages.ts:

KeyWhere it appears
seo.default.title, seo.default.descriptionThe fallback title and description from the root document
seo.home.title, seo.home.descriptionThe home page
content.blogCopyThe blog index intro, with the CMS module

How copy is organised is covered in Add and change copy.

Replace the icons and the share image

Choose generated or hand-made artwork

The project ships placeholder artwork drawn by a script. Either keep the generator and give it your name and colours, or replace the files with your own.

To regenerate, edit the constants at the top of scripts/assets/generate-site-assets.ts (siteName, tagline and palette), then run:

pnpm assets:generate

It rewrites favicon.svg, favicon.ico, apple-touch-icon.png, icon-192.png, icon-512.png and og-default.png in public/, plus the images under public/placeholder/.

Or replace the files by hand

Keep these names and sizes, because the root document, the manifest and the shells reference them by path:

FileSizeUsed for
public/favicon.svgvectorThe browser tab, and the logo mark in the public header, auth and system pages
public/favicon.ico32×32Browsers without SVG icon support
public/apple-touch-icon.png180×180iOS home screen
public/icon-192.png, public/icon-512.png192×192, 512×512The web manifest
public/og-default.png1200×630The default share image

If you run pnpm assets:generate later it overwrites these files.

Match the browser chrome to your palette

Set themeColor and backgroundColor in site.ts to your primary colour and page background. They are plain hex strings and do not follow the CSS tokens automatically. If you change --primary or --background, change them here too. See Use the design system.

Check metadata and the sitemap

Pages build their <head> through buildMeta() in src/lib/seo.ts, which falls back to the site config for anything a page does not supply. You maintain two lists:

  1. Open src/server/services/static-seo.service.ts and edit publicSeoRoutes: remove pages you deleted and add public pages you created. /sitemap.xml renders this list once per locale with hreflang alternates.
  2. Leave robots.txt alone unless you add another private area. It is served from src/routes/robots[.]txt.ts, already disallows /admin, /app and /api, and points at the sitemap on your configured origin.

Do not add a public/sitemap.xml. It would shadow the route, and pnpm validate:site-metadata fails.

Set the email sender name

The email shell takes the product name from site.ts, but the sender is a stored setting. Open Settings → Email Config (/admin/config/email) and set the from address to your own name and verified domain. See Send transactional email.

Choose where signed-in users land

A visitor who signs in from a protected page returns to it through the redirectTo parameter. Without one, they land on signedInHome in src/config/site.ts, which is /app/profile by default. Sign-in, sign-up, social sign-in and the button shown after a verified email all read it.

signedInHome: "/app",

Write a site-relative path under /app without a locale prefix. The prefix is added for the visitor's language, and the auth pages only follow relative paths outside /auth.

Verify

pnpm validate:site-metadata
pnpm validate:example-landing
pnpm typecheck

Then start pnpm dev and check:

  • The header, the browser tab and /auth/sign-in show your name and mark.
  • /manifest.webmanifest returns your name, short_name and colours.
  • /sitemap.xml and /robots.txt use your origin when SITE_URL is set.
  • View source on /: og:title, og:image and the canonical link carry your name and domain.
  • Sign out and sign in again: you land on the page you chose.

pnpm validate:site-metadata fails when an icon is missing, when a source file references an image that is not in public/, or when a page writes its own canonical link instead of calling buildMeta().

Next steps