Merge branch 'ishaan1013:main' into feat/dockerfile

README.md

@@ -6,6 +6,8 @@ Sandbox is an open-source cloud-based code editing environment with custom AI co
 
 Check out the [Twitter thread](https://x.com/ishaandey_/status/1796338262002573526) with the demo video!
 
+Check out this [guide](https://dev.to/jamesmurdza/how-to-setup-ishaan1013sandbox-locally-503p) made by [@jamesmurdza](https://x.com/jamesmurdza) on setting it up locally!
+
 ## Running Locally
 
 ### Frontend

backend/database/wrangler.example.toml

@@ -6,11 +6,14 @@ compatibility_flags = ["nodejs_compat"]
 
 services = [{ binding = "STORAGE", service = "storage" }]
 
+# Create a new D1 database using the Wrangler CLI and fill in database_name and database_id.
 [[d1_databases]]
 binding = "DB"
 database_name = ""
 database_id = ""
 
+# Set STORAGE_WORKER_URL after deploying the worker.
+# Set KEY to be the same as KEY in /backend/storage/wrangler.toml.
 [vars]
 KEY = ""
 STORAGE_WORKER_URL = ""

backend/server/.env.example

@@ -1,2 +1,7 @@
+# Set WORKERS_KEY to be the same as KEY in /backend/storage/wrangler.toml.
+# Set DATABASE_WORKER_URL and STORAGE_WORKER_URL after deploying the workers.
+
 PORT=4000
-WORKERS_KEY=
+WORKERS_KEY=
+DATABASE_WORKER_URL=
+STORAGE_WORKER_URL=

backend/storage/wrangler.example.toml

@@ -4,13 +4,16 @@ main = "src/index.ts"
 compatibility_date = "2024-04-05"
 compatibility_flags = ["nodejs_compat"]
 
+# Fill in the account ID from the Cloudflare dashboard below.
 account_id = ""
 workers_dev = true
 
+# Deploy an R2 bucket from the Cloudflare dashboard and fill in bucket_name.
 [[r2_buckets]]
 binding = 'R2'
 bucket_name = ''
 preview_bucket_name = ''
 
+# KEY is required but can be set to any secret string.
 [vars]
 KEY = ''

frontend/.env.example

@@ -6,8 +6,11 @@ LIVEBLOCKS_SECRET_KEY=
 NEXT_PUBLIC_SERVER_PORT=4000
 NEXT_PUBLIC_APP_URL=http://localhost:3000
 
+# Set WORKER_URLs after deploying the workers.
+# Set NEXT_PUBLIC_WORKERS_KEY to be the same as KEY in /backend/storage/wrangler.toml.
 NEXT_PUBLIC_DATABASE_WORKER_URL=
 NEXT_PUBLIC_STORAGE_WORKER_URL=
+NEXT_PUBLIC_WORKERS_KEY=
 
 NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
 NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up