docs: add readme for postgres-new next project

gregnr · gregnr · commit b270472f8575 · 2024-08-11T18:15:17.000-05:00
diff --git a/apps/postgres-new/README.md b/apps/postgres-new/README.md
@@ -2,9 +2,32 @@
 
 In-browser Postgres sandbox with AI assistance. Built on Next.js.
 
+## Architecture
+
+We use PGlite for 2 purposes:
+
+1. A "meta" DB that keeps track of all of the user databases along with their message history
+2. A "user" DB for each database the user creates along with whatever tables/data they've created
+
+Both databases are stored locally in the browser via IndexedDB. This means that these databases are not persisted to the cloud and cannot be accessed from multiple devices (though this is on the roadmap).
+
+Every PGlite instance runs in a Web Worker so that the main thread is not blocked.
+
+## AI
+
+The AI component is powered by OpenAI's GPT-4o model. The project uses [Vercel's AI SDK ](https://sdk.vercel.ai/docs/introduction) to simplify message streams and tool calls.
+
+## Authentication
+
+Because LLMs cost money, a lightweight auth wall exists to prevent abuse. It is currently only used to validate that the user has a legitimate GitHub account, but in the future it could be used to save private/public databases to the cloud.
+
+Authentication and users are managed by a [Supabase](https://supabase.com/) database. You can find the migrations and other configuration for this in the root [`./supabase`](../../supabase/) directory.
+
 ## Development
 
-1. Install deps:
+From this directory (`./apps/postgres-new`):
+
+1. Install dependencies:
    ```shell
    npm i
    ```
