Merge pull request #117 from supabase-community/feat/deploy-with-supabase

feat: database deployment on Supabase

Author: jgoux

.dockerignore

@@ -0,0 +1,4 @@
+**/node_modules
+**/.next
+**/.turbo
+**/.env*

.gitignore

@@ -41,3 +41,4 @@ tls/
 dist/
 
 .env
+.turbo

README.md

@@ -23,8 +23,63 @@ How is this possible? [PGlite](https://pglite.dev/), a WASM version of Postgres
 
 This is a monorepo split into the following projects:
 
-- [Frontend (Next.js)](./apps/postgres-new/): This contains the primary web app built with Next.js
-- [Backend (pg-gateway)](./apps/db-service/): This serves S3-backed PGlite databases over the PG wire protocol using [pg-gateway](https://github.com/supabase-community/pg-gateway)
+- [Web](./apps/postgres-new/): The primary web app built with Next.js
+- [Browser proxy](./apps/browser-proxy/): Proxies Postgres TCP connections back to the browser using [pg-gateway](https://github.com/supabase-community/pg-gateway) and Web Sockets
+- [Deploy worker](./apps/deploy-worker/): Deploys in-browser databases to database platforms (currently Supabase is supported)
+
+### Setup
+
+From the monorepo root:
+
+1. Install dependencies
+
+   ```shell
+   npm i
+   ```
+
+2. Start local Supabase stack:
+   ```shell
+   npx supabase start
+   ```
+3. Store local Supabase URL/anon key in `./apps/postgres-new/.env.local`:
+   ```shell
+   npx supabase status -o env \
+     --override-name api.url=NEXT_PUBLIC_SUPABASE_URL \
+     --override-name auth.anon_key=NEXT_PUBLIC_SUPABASE_ANON_KEY |
+       grep NEXT_PUBLIC >> ./apps/postgres-new/.env.local
+   ```
+4. Create an [OpenAI API key](https://platform.openai.com/api-keys) and save to `./apps/postgres-new/.env.local`:
+   ```shell
+   echo 'OPENAI_API_KEY="<openai-api-key>"' >> ./apps/postgres-new/.env.local
+   ```
+5. Store local KV (Redis) vars. Use these exact values:
+
+   ```shell
+   echo 'KV_REST_API_URL="http://localhost:8080"' >> ./apps/postgres-new/.env.local
+   echo 'KV_REST_API_TOKEN="local_token"' >> ./apps/postgres-new/.env.local
+   ```
+
+6. Start local Redis containers (used for rate limiting). Serves an API on port 8080:
+
+   ```shell
+   docker compose -f ./apps/postgres-new/docker-compose.yml up -d
+   ```
+
+7. Fill in the remaining variables for each app as seen in:
+
+   - `./apps/postgres-new/.env.example`
+   - `./apps/browser-proxy/.env.example`
+   - `./apps/deploy-worker/.env.example`
+
+### Development
+
+From the monorepo root:
+
+```shell
+npm run dev
+```
+
+_**Important:** This command uses `turbo` under the hood which understands the relationship between dependencies in the monorepo and automatically builds them accordingly (ie. `./packages/*`). If you by-pass `turbo`, you will have to manually build each `./packages/*` before each `./app/*` can use them._
 
 ## Why rename postgres.new?
 

apps/browser-proxy/README.md

@@ -8,17 +8,9 @@ It is using a WebSocket server and a TCP server to make the communication betwee
 
 Copy the `.env.example` file to `.env` and set the correct environment variables.
 
-Install dependencies:
+Run the dev server from the monorepo root. See [Development](../../README.md#development).
 
-```sh
-npm install
-```
-
-Start the proxy in development mode:
-
-```sh
-npm run dev
-```
+The browser proxy will be listening on ports `5432` (Postgres TCP) and `443` (Web Sockets).
 
 ## Deployment
 
@@ -30,4 +22,4 @@ Deploy the app:
 
 ```sh
 fly deploy --app database-build-browser-proxy
-```
+```