summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBertrand Yuan <github@bertyuan.com>2026-04-27 23:47:07 +0800
committerBertrand Yuan <github@bertyuan.com>2026-04-27 23:47:07 +0800
commit66b79706e886432ffa7c134ec39a87f43c43f3c1 (patch)
treee56ff06f03f308062fc58fec1a4aae73bd7298f7 /README
parent4b6b62a97f6d7765f80bd2f92d919a7d1522a36f (diff)
docs: update README with Docker DATABASE_URL exampleHEADmaster
Added an example for the DATABASE_URL configuration in the Docker section of the README. Included instructions for creating the PostgreSQL schema before running migrations to ensure proper setup for the application. Signed-off-by: Bertrand Yuan <github@bertyuan.com>
Diffstat (limited to 'README')
-rw-r--r--README29
1 files changed, 23 insertions, 6 deletions
diff --git a/README b/README
index 1460ae7..13c5e94 100644
--- a/README
+++ b/README
@@ -59,7 +59,10 @@ docker run -d \
postgres:15.1
Then, copy .env.example to .env and fill in the required environment variables
-that suit your setup.
+that suit your setup. For the Docker command above, DATABASE_URL should look
+like this:
+
+postgresql://admin:YOUR_PASSWORD_HERE@localhost:5432/db
Generate authentication key: This project uses Better Auth.
A secure key of at least 32 characters must be provided.
@@ -75,11 +78,25 @@ Run installation of react-syntax-highlighter dependencies:
pnpm add react-syntax-highlighter
pnpm add -D @types/react-syntax-highlighter
-Run Payload CMS migrations: pnpm payload migrate
-Run database migrations: pnpm db:push
-(optional: SKIP_ENV_VALIDATION=1 pnpm db:push)
-Start the development server: pnpm dev
-(optional SKIP_ENV_VALIDATION=1 pnpm dev)
+Create the Payload PostgreSQL schema before running Payload migrations:
+pnpm tsx scripts/create-payload-schema.mts
+
+Run Payload CMS migrations:
+pnpm payload:migrate
+
+Run database migrations:
+pnpm db:push
+
+If OAuth environment variables are not configured locally, skip validation for
+database push and development startup:
+SKIP_ENV_VALIDATION=1 pnpm db:push
+
+Start the development server:
+pnpm dev
+
+Or, with local env validation skipped:
+SKIP_ENV_VALIDATION=1 pnpm dev
+
Open <http://localhost:3000>
Core Modules