From 16beac045c2a15c145e204d185131385c2214998 Mon Sep 17 00:00:00 2001 From: Shishant Biswas Date: Mon, 16 Mar 2026 19:23:33 +0530 Subject: [PATCH] update README --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ad0386f..91166e0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# bknd + Tanstack Start Example +# bknd + Tanstack Start Example (Docker) -This is a minimal example to shows how to integrate bknd with Tanstack Start. +This is a minimal example to shows how to integrate bknd with Tanstack Start for Docker deployment. ## Setup @@ -52,4 +52,24 @@ bun run dev ## Test Credentials - Email: `test@bknd.io` -- Password: `12345678` \ No newline at end of file +- Password: `12345678` + +## For Building the Docker Image + +```bash +docker build -t bknd-examples:tanstack-start . +``` + +## For Deployment on Docker (using docker compose) + +1. Run `docker compose up -d` + +## For Local Development + +1. Run `bun run dev` +2. Open `http://localhost:3000` +3. Open `http://localhost:3000/admin` for Admin Dashboard + + +## For Cloudflare Workers deployment +Checkout the `cf-tanstack` branch for Cloudflare Workers deployment instructions. \ No newline at end of file