From 15012d8686f0a28bf70bd6a69c6e47ed0be9af73 Mon Sep 17 00:00:00 2001 From: Andrew Montalenti Date: Fri, 2 Oct 2026 13:24:20 -0400 Subject: [PATCH] Update README.md Based on getting local development set up, update the local setup steps for clarity. Also: fix small bug related to location of env file -- `.env` vs `.env.local` (which `pnpm dev` seems to expect). --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 21cb177c3..e6e809902 100644 --- a/README.md +++ b/README.md @@ -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)