First steps after install
Read the setup checklist, connect email, then choose which customisation guide to open next.
You have a project running and you are signed in as administrator. This page takes it to the point where people can sign up: read the setup checklist, connect email, then start turning the template into your own product.
Before you begin
- A running project from the Quick start.
- You are signed in at
/auth/sign-inwith the administrator account. - Credentials for one email provider: Resend, Cloudflare Email or Aliyun DirectMail.
Read the setup checklist
Open /setup
The page reads live configuration, so it shows what this deployment can do now. Each item is Ready or Not ready, and Configure opens the page that fixes it.
Check the required items
Four items are required. The rest are optional; set them up only when your product needs them.
| Item | Required | Where you fix it |
|---|---|---|
| Session secret | Yes | BETTER_AUTH_SECRET in .env; you set it in the quick start |
| Sign-in method | Yes | Settings → Auth Config; email and password is on by default |
| Email delivery | Yes | Settings → Email Config |
| Scheduled jobs | Yes | Nothing locally: pnpm dev runs a round every minute. In production it depends on the platform; see Troubleshoot a project |
| Payment provider | optional | Settings → Payment Config |
| Object storage | optional | Settings → Storage Config |
| AI channels | optional | Settings → AI Config |
| Newsletter provider | optional | The waitlist's Provider settings tab, with the newsletter module |
| Analytics provider | optional | Settings → Analytics Config |
On a fresh project only Email delivery is usually missing. Scheduled jobs turns Ready within a minute of the server starting.
Connect email
Verification and password reset emails cannot be sent until a provider is active, so do this first.
Open Email Config
On /setup, click Configure next to Email delivery, or go to Settings → Email Config.
Fill in one provider
Enter the provider's credentials: an API key for Resend, an Account ID and API token for Cloudflare, or an AccessKey ID, AccessKey Secret and Sender account for Aliyun. Set the From address your emails come from.
Make it active and save
Tick Set as active email provider and click Save provider. The page confirms with Email provider configuration saved.
Provider-specific details, templates and the delivery log are in Send transactional email.
Make the project yours
The project works, but it still looks and reads like the template. Each of these has its own guide. Do them in this order, and skip what you do not need yet.
| You want to | Open |
|---|---|
| Put your name, domain, icons and share image on it | Rebrand the project |
Replace the example home page and understand /pricing | Replace the landing and pricing pages |
| Change colours and fonts, or restyle a screen | Use the design system |
| Rewrite copy in English and Chinese | Add and change copy |
Add your first product screen under /app or /admin | Add an admin or workspace page |
The quickest visible change is the first one: edit src/config/site.ts, which holds the site name,
canonical URL, description and social image.
Verify
Go back to /setup. Email delivery now shows Ready, and the page shows
Nothing required is missing. Sign up with a second email address in a private window: the
verification email arrives from your From address.
Troubleshooting
/setup sends me to the sign-in page
You are not signed in. Sign in at /auth/sign-in with the administrator account and open /setup again.
/setup shows a permission denied page
The account you signed in with is not an administrator. Sign in with the account created by
pnpm db:bootstrap-super-admin.
Email delivery stays Not ready after saving
The provider was saved without being made active, or a required credential is empty. Tick Set as active email provider, fill in every credential for that provider and save again.
Something else is wrong
Troubleshoot a project lists symptoms and fixes for the session secret, generated types, migrations, scheduled jobs and the agent.
Next steps
Rebrand the project
Name, domain, icons, share image and metadata.
Replace the landing and pricing pages
Rewrite the example home page.
Connect a payment provider
Charge for your product with Stripe, Creem, PayPal, DodoPayments, WeChat Pay, Alipay or Waffo.
Deploy your project
Go live on Cloudflare, Fly.io, Railway or Docker.