ENG-520 Instructions to set up the supabase environment, either local or production.

.gitignore

@@ -7,7 +7,12 @@ node_modules
 
 # Local env files
 .env
-.env.*
+.env.localdb
+.env.productiondb
+# The same for shell variants
+.env.*sh
+.env.localdb.*sh
+.env.productiondb.*sh
 
 # Testing
 coverage

README.md

@@ -29,6 +29,7 @@ Learn more about how monorepos improve development workflows [here](https://verc
 - [typescript-config](https://github.com/DiscourseGraphs/discourse-graph/tree/main/packages/typescript-config): Shared tsconfig.jsons
 - [eslint-config](https://github.com/DiscourseGraphs/discourse-graph/tree/main/packages/eslint-config): ESLint preset
 - [ui](https://github.com/DiscourseGraphs/discourse-graph/tree/main/packages/ui): Core React components
+- [database](https://github.com/DiscourseGraphs/discourse-graph/tree/main/packages/database): Database configuration
 
 ### Getting Started
 
@@ -59,6 +60,8 @@ You can use the `--filter` flag to run a single application, eg:
 turbo dev --filter roam
 ```
 
+1. Set up a supabase environment. This will cache and optimize some semantic queries. You may not need both environments, but you cannot develop unless `SUPABASE_URL` and `SUPABASE_ANON_KEY` are defined. Full instructions [here](https://github.com/DiscourseGraphs/discourse-graph/tree/main/packages/database/README.md).
+
 #### Roam
 
 - go to your graph, open up settings, and go to the extensions tab

apps/obsidian/.env.example

@@ -1 +1,7 @@
-# OBSIDIAN_PLUGIN_PATH="path/to/your/obsidian/plugins/folder"
+# OBSIDIAN_PLUGIN_PATH="path/to/your/obsidian/plugins/folder"
+# SUPABASE_WORKDIR=/full/path/to/packages/database
+SUPABASE_URL=http://127.0.0.1:54321
+SUPABASE_PROJECT_ID=discourse-graphs
+POSTGRES_URL=postgresql://postgres:postgres@127.0.0.1:54322/postgres
+# SUPABASE_JWT_SECRET=<'JWT secret' value from supabase start>
+# SUPABASE_ANON_KEY=<'anon key' value from supabase start>

apps/obsidian/.env.productiondb.example

@@ -0,0 +1,5 @@
+# OBSIDIAN_PLUGIN_PATH="path/to/your/obsidian/plugins/folder"
+# SUPABASE_WORKDIR=/full/path/to/packages/database
+SUPABASE_URL=https://zytfjzqyijgagqxrzbmz.supabase.co
+SUPABASE_PROJECT_ID=zytfjzqyijgagqxrzbmz
+SUPABASE_ANON_KEY=<obtain from 1password>

apps/roam/.env.example

@@ -1 +1,7 @@
-# BLOB_READ_WRITE_TOKEN=
+# BLOB_READ_WRITE_TOKEN =
+# SUPABASE_WORKDIR=/full/path/to/packages/database
+SUPABASE_URL=http://127.0.0.1:54321
+SUPABASE_PROJECT_ID=discourse-graphs
+POSTGRES_URL=postgresql://postgres:postgres@127.0.0.1:54322/postgres
+# SUPABASE_JWT_SECRET=<'JWT secret' value from supabase start>
+# SUPABASE_ANON_KEY=<'anon key' value from supabase start>

apps/roam/.env.productiondb.example

@@ -0,0 +1,5 @@
+# BLOB_READ_WRITE_TOKEN =
+# SUPABASE_WORKDIR=/full/path/to/packages/database
+SUPABASE_URL=https://zytfjzqyijgagqxrzbmz.supabase.co
+SUPABASE_PROJECT_ID=zytfjzqyijgagqxrzbmz
+SUPABASE_ANON_KEY=<obtain from 1password>

apps/website/.env.example

@@ -1,3 +1,11 @@
+# NEXT_PUBLIC_POSTHOG_HOST=https://us.i.posthog.com
 # RESEND_API_KEY=
 # NEXT_PUBLIC_POSTHOG_KEY=phc_KllQh2hOMmXJ3YwdiLHswb1CfOaEWzoC30mA0u3ZJgp
-# NEXT_PUBLIC_POSTHOG_HOST=https://us.i.posthog.com
+# SUPABASE_WORKDIR=/full/path/to/packages/database
+SUPABASE_URL=http://127.0.0.1:54321
+SUPABASE_PROJECT_ID=discourse-graphs
+POSTGRES_URL=postgresql://postgres:postgres@127.0.0.1:54322/postgres
+# SUPABASE_JWT_SECRET=<'JWT secret' value from supabase start>
+# SUPABASE_ANON_KEY=<'anon key' value from supabase start>
+# ⚠️ Never commit the real key below – keep it in a private *.env file
+# SUPABASE_SERVICE_ROLE_KEY=<'service_role key' value from supabase start>

apps/website/.env.productiondb.example

@@ -0,0 +1,9 @@
+# NEXT_PUBLIC_POSTHOG_HOST=https://us.i.posthog.com
+# RESEND_API_KEY=
+# NEXT_PUBLIC_POSTHOG_KEY=phc_KllQh2hOMmXJ3YwdiLHswb1CfOaEWzoC30mA0u3ZJgp
+# SUPABASE_WORKDIR=/full/path/to/packages/database
+SUPABASE_URL=https://zytfjzqyijgagqxrzbmz.supabase.co
+SUPABASE_PROJECT_ID=zytfjzqyijgagqxrzbmz
+SUPABASE_ANON_KEY=<obtain from 1password>
+SUPABASE_SERVICE_ROLE_KEY=<obtain from 1password>
+SUPABASE_JWT_SECRET=<obtain from 1password>