Skip to main content

Documentation Index

Fetch the complete documentation index at: https://shipfree.revoks.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Quickstart

​
Prerequisites

  • Bun installed
  • PostgreSQL running locally or accessible

​
Install and run

1

Install dependencies

bun install
2

Set environment variables

cp .env.example .env
Update at least these values:
  • DATABASE_URL
  • BETTER_AUTH_SECRET
  • BETTER_AUTH_URL
  • NEXT_PUBLIC_APP_URL
3

Run migrations

bun run migrate:local
4

Start dev server

bun dev

​
Verify core flows

  • Visit /login and try email OTP sign-in
  • Open /dashboard after login
  • Trigger a password reset to validate email delivery
If you do not configure an email provider, emails are logged to the console by the log provider.