docs(aigency): describe prerequisites

Author: alsakhaev

apps/crawler-backend/.env.example

@@ -0,0 +1,7 @@
+OPENAI_API_KEY=sk-proj-example-key
+NEARAI_API_KEY={"account_id":"example.near","signature":"example==","public_key":"ed25519:example","callback_url":"http://localhost:54875/capture","nonce":"1234567890","recipient":"ai.near","message":"Welcome to NEAR AI","on_behalf_of":null}
+CRAWLER_API_PORT=3000
+CRAWLER_DATABASE_URL=postgres://mweb:mweb@postgres:5432/mweb
+OPENFAAS_USERNAME=admin
+OPENFAAS_PASSWORD=admin
+OPENFAAS_URL=http://gateway.aigency:8080

apps/crawler-backend/README.md

@@ -1,5 +1,14 @@
 # Backend
 
+## Prerequisites
+
+1. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
+2. Go to Settings, enable Kubernetes, click on Apply & Restart
+3. Create `helm/values.yaml` and `.env` files as written above (see also `helm/values.example.yaml` and `.example.env`)
+4. Install [Lens](https://k8slens.dev/) [Optionally]
+5. Install [`kubectl`](https://kubernetes.io/docs/tasks/tools/)
+6. Install [`helm`](https://helm.sh/docs/intro/install/)
+
 ## Install with Helm
 
 Create `values.yaml` with the following secrets:
@@ -11,12 +20,29 @@ nearAiApiKey: '{"account_id":"example.near","signature":"example==","public_key"
 
 Install helm chart from GitHub Registry:
 
-```sh
-helm upgrade aigency oci://ghcr.io/dapplets/aigency --install --create-namespace --namespace aigency -f ./values.yaml
+```bash
+cd apps/crawler-backend
+kubectl create namespace openfaas-fn
+helm upgrade aigency oci://ghcr.io/dapplets/aigency --install --create-namespace --namespace aigency -f ./helm/values.yaml
+```
+
+If the `secrets "basic-auth" already exists` error occured, try this:
+
+```bash
+helm upgrade aigency oci://ghcr.io/dapplets/aigency --install --create-namespace --namespace aigency -f ./helm/values.yaml
+helm uninstall aigency --namespace aigency
+helm upgrade aigency oci://ghcr.io/dapplets/aigency --install --create-namespace --namespace aigency -f ./helm/values.yaml
+helm upgrade aigency oci://ghcr.io/dapplets/aigency --install --create-namespace --namespace aigency -f ./helm/values.yaml
 ```
 
 Aigency will be available at `http://localhost:30001`
 
+Add port forwarding to PostgreSQL
+
+```
+kubectl port-forward service/postgres 5432 5432 --namespace aigency
+```
+
 ## Development
 
 ### Run PostgreSQL

apps/crawler-backend/helm/values.example.yaml

@@ -0,0 +1,2 @@
+openaiApiKey: sk-proj-example-key
+nearAiApiKey: '{"account_id":"example.near","signature":"example==","public_key":"ed25519:example","callback_url":"http://localhost:54875/capture","nonce":"1234567890","recipient":"ai.near","message":"Welcome to NEAR AI","on_behalf_of":null}'

apps/crawler-backend/src/env.ts

@@ -6,7 +6,7 @@ export const CRAWLER_PRIVATE_KEY =
 
 export const CRAWLER_DATABASE_URL =
   process.env.CRAWLER_DATABASE_URL ??
-  'postgres://user:password@localhost:5432/mweb';
+  'postgres://mweb:mweb@localhost:5432/mweb';
 
 export const OPENAI_API_KEY = process.env.OPENAI_API_KEY;