Merge pull request #118 from eye-on-surveillance/ma/docs-docs

docs: first time run

README.md

@@ -29,5 +29,13 @@ curl -XPOST http://localhost:8080 -v -H "Content-Type: application/json" \
 ## Project structure
 
 - `packages/backend`: Preprocessor, only needs to be run once
+  - [Embeddings creation](https://github.com/eye-on-surveillance/sawt/blob/3f9a17bdd6ee3f0ffe1a454a332f9d4d6f28086e/packages/backend/src/preprocessor.py#L21)
+  - [Sample tuning params](https://github.com/eye-on-surveillance/sawt/blob/3f9a17bdd6ee3f0ffe1a454a332f9d4d6f28086e/packages/backend/src/preprocessor.py#L77)
 - `packages/googlecloud`: Google Cloud Function invoked for every query
+  - [Entry point](https://github.com/eye-on-surveillance/sawt/blob/3f9a17bdd6ee3f0ffe1a454a332f9d4d6f28086e/packages/googlecloud/functions/getanswer/main.py#L20)
+  - [K gets set](https://github.com/eye-on-surveillance/sawt/blob/3f9a17bdd6ee3f0ffe1a454a332f9d4d6f28086e/packages/googlecloud/functions/getanswer/inquirer.py#L188)
+  - [Construct response, all stored to DB](https://github.com/eye-on-surveillance/sawt/blob/3f9a17bdd6ee3f0ffe1a454a332f9d4d6f28086e/packages/googlecloud/functions/getanswer/inquirer.py#L108)
+  - [Deployment logic](https://github.com/eye-on-surveillance/sawt/blob/3f9a17bdd6ee3f0ffe1a454a332f9d4d6f28086e/.github/workflows/main.yml)
 - `packages/web`: NextJS web site
+  - [DB migrations](https://github.com/eye-on-surveillance/sawt/tree/3f9a17bdd6ee3f0ffe1a454a332f9d4d6f28086e/packages/web/supabase/migrations)
+  - [Homepage](https://github.com/eye-on-surveillance/sawt/blob/3f9a17bdd6ee3f0ffe1a454a332f9d4d6f28086e/packages/web/app/page.tsx)

docs/seq.md

@@ -0,0 +1,10 @@
+seqdiag {
+User-Browser -> Vercel-NextJS [label = "GET SITE JS"];
+User-Browser <-- Vercel-NextJS
+User-Browser -> Supabase [label = "GET CARD DATA"];
+User-Browser <-- Supabase
+User-Browser -> Google-Cloud-Function [label = "SUBMIT QUESTION"]
+User-Browser <-- Google-Cloud-Function
+User-Browser -> Supabase [label = "SUBMIT NEW CARD"];
+User-Browser <-- Supabase
+}

packages/googlecloud/functions/getanswer/README.md

@@ -7,6 +7,7 @@ python3.10 getanswer
 ```
 
 ## Running locally
+
 [Docs](https://cloud.google.com/functions/docs/running/function-frameworks)
 
 ```
@@ -43,9 +44,8 @@ gcloud functions deploy getanswer-staging \
 
 gcloud functions describe highlight-to-nft --gen2 --region us-east1 --format="value(serviceConfig.uri)"
 
-curl -XPOST hhttps://getanswer-q5odwl64qa-ue.a.run.app \
-    -H "Content-Type: application/json" \
-    -d '{"question":"Outline concerns raised during the meeting? What were the responses to those concerns?","response_type":"general"}'
+curl -XPOST https://us-east1-the-great-inquirer.cloudfunctions.net/getanswer-staging -v -H "Content-Type: application/json" \
+    -d '{"query":"Is councilmember Green effective?","response_type":"in_depth"}'
 ```
 
 response_types = 'general' or 'in_depth'
@@ -58,4 +58,4 @@ import openai
 import os
 key = os.environ.get("OPENAI_API_KEY").replace("'", "")
 openai.api_key = key
-```
+```

packages/web/README.md

@@ -8,8 +8,8 @@ Create a `.env.local` like this:
 # If running functions locally
 NEXT_PUBLIC_TGI_API_ENDPOINT=http://localhost:8080
 
-# Run against production
-NEXT_PUBLIC_TGI_API_ENDPOINT=https://getanswer-q5odwl64qa-ue.a.run.app
+# Run against staging
+NEXT_PUBLIC_TGI_API_ENDPOINT=https://us-east1-the-great-inquirer.cloudfunctions.net/getanswer-staging
 
 # All environments
 NEXT_PUBLIC_SUPABASE_URL=your-supabase-url
@@ -25,3 +25,15 @@ yarn dev
 # or
 pnpm dev
 ```
+
+### Supabase migrations
+
+The first time you setup a new Supabase project, migrations must be applied.
+
+```
+supabase login
+supabase link --project-ref $PROJECT_ID
+supabase db push
+```
+
+To make changes to the schema moving forward, you can update the DB directly from Supabase DB. When ready, run `supabase db remote commit`. You will need to have Docker running locally for this to succeed. When complete, there will be a new file in `supabase/migrations` with a name like `20230821153353_remote_commit.sql`. Commit this file to source control and it will automatically be applied to the DB when merged.