Skip to content

Update README.md #409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hfellerhoff merged 1 commit into from
Oct 2, 2026
Merged

Update README.md #409

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ Getting up and running with Serial is easy. Here are the steps you need to start

1. Clone the repository locally
2. Install the Turso CLI: https://github.com/tursodatabase/turso-cli
3. Copy `apps/app/.env.example` to `apps/app/.env`
4. Set `PUBLIC_BASE_URL` to `http://localhost:3000`
5. Navigate to [Better Auth](https://www.better-auth.com/docs/installation#set-environment-variables) and generate an auth secret. Set it as `BETTER_AUTH_SECRET`
6. Install Node.js 22.12 or newer.
7. Install [pnpm](https://pnpm.io/) if you don't have it already.
8. Run `pnpm i` to install packages.
9. Run `pnpm dev` to create, migrate, and run your database for the first time, then boot up the development server.
3. Make a local env file: `cp apps/app/.env.example apps/app/.env.local`
4. Set `PUBLIC_BASE_URL` in `.env.local` to `http://localhost:3000`
5. Navigate to [Better Auth](https://www.better-auth.com/docs/installation#set-environment-variables) and generate an auth secret. Set it as `BETTER_AUTH_SECRET` in `.env.local`
6. Check your Node version with `node -v`; you should install Node.js 22.12 or newer
7. Install [pnpm](https://pnpm.io/) if you don't have it already
8. Run `pnpm i` to install packages
9. Run `pnpm dev` to create, migrate, and run your database for the first time, then boot up the development server

If you'd like to support additional features in development, [see below!](#enabling-additional-features)

Expand Down
Loading