diff --git a/docs/archive/launch_readme.md b/docs/archive/launch_readme.md index 9ddd9bd..95f5eea 100644 --- a/docs/archive/launch_readme.md +++ b/docs/archive/launch_readme.md @@ -43,7 +43,7 @@ Adeus consists of 3 parts: an interface that lets the user to interact with their assistant and data via chat. 2. **Hardware device (Currently Coral AI, but soon a Rasberry-Pi Zero W worth $15):** this will be the wearable that will record everything, and send it to the backend to be processed -3. **Supabase :** Our backend, and datavase, where we will process and store data, and interact with LLMs. +3. **Supabase :** Our backend, and database, where we will process and store data, and interact with LLMs. Supabase is an open source Firebase alternative, a "backend-as-a-service" - which allows you to setup a Postgres database, Authentication, Edge Functions, Vector embeddings, and more - for free (at first) and at extreme ease! - [!!] But more importantly - **it is open source, and you can choose to deploy and manage your own Supabase instance** - which us crucial for our mission: A truly open-source, personal AI. diff --git a/docs/getting_started.md b/docs/getting_started.md index 48210e8..608b8d2 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -50,13 +50,13 @@ We will use Supabase as our database (with vector search, pgvector), authenticat 7. If so, go to your terminal, and cd to the supabase folder: `cd ./supabase` -8. Install Supabase and set up the CLI. You should follow thier [guide here](https://supabase.com/../guides/cli/getting-started?platform=macos#installing-the-supabase-cli), but in short: - - run `brew install supabase/tap/supabase` to install the CLI (or [check other options](https://supabase.com/../guides/cli/getting-started)) +8. Install Supabase and set up the CLI. You should follow thier [guide here](https://supabase.com/docs/guides/cli/getting-started?platform=macos#installing-the-supabase-cli), but in short: + - run `brew install supabase/tap/supabase` to install the CLI (or [check other options](https://supabase.com/docs/guides/cli/getting-started)) - Install [Docker Desktop](https://www.docker.com/products/docker-desktop/) on your computer (we won't use it, we just need docker daemon to run in the background for deploying supabase functions) 9. Now when we have the CLI, we need to login with our Supabase account, running `supabase login` - this should pop up a browser window, which should prompt you through the auth 10. And link our Supabase CLI to a specific project, our newly created one, by running `supabase link --project-ref ` (you can check what the project id is from the Supabase web UI, or by running `supabase projects list`, and it will be under "reference id") - you can skip (enter) the database password, it's not needed. 11. Now we need to apply the Adeus DB schema on our newly created, and empty database. We can do this by simply run: `supabase db push`. We can verify it worked by going to the Supabase project -> Tables -> and see that new tables were created. -12. Now let's deploy our functions! ([see guide for more details](https://supabase.com/../guides/functions/deploy)) `supabase functions deploy --no-verify-jwt` (see [issue re:security](https://github.com/adamcohenhillel/AdDeus/issues/3)) +12. Now let's deploy our functions! ([see guide for more details](https://supabase.com/docs/guides/functions/deploy)) `supabase functions deploy --no-verify-jwt` (see [issue re:security](https://github.com/adamcohenhillel/AdDeus/issues/3)) 13. If you're planning to first use OpenAI as your Foundation model provider, then you'd need to also run the following command, to make sure the functions have everything they need to run properly: `supabase secrets set OPENAI_API_KEY=` (Ollama setup guide is coming out soon) 14. If you want access to tons of AI Models, both Open & Closed Source, set up your OpenRouter API Key. Go to [OpenRouter](https://openrouter.ai/) to get your API Key, then run `supabase secrets set OPENROUTER_API_KEY=`. diff --git a/docs/index.md b/docs/index.md index b67a295..adeea93 100644 --- a/docs/index.md +++ b/docs/index.md @@ -39,7 +39,7 @@ Adeus consists of 3 parts: an interface that lets the user to interact with their assistant and data via chat. 2. **Hardware device (Currently Coral AI, but soon a Rasberry-Pi Zero W worth $15):** this will be the wearable that will record everything, and send it to the backend to be processed -3. **Supabase :** Our backend, and datavase, where we will process and store data, and interact with LLMs. +3. **Supabase :** Our backend, and database, where we will process and store data, and interact with LLMs. Supabase is an open source Firebase alternative, a "backend-as-a-service" - which allows you to setup a Postgres database, Authentication, Edge Functions, Vector embeddings, and more - for free (at first) and at extreme ease! - [!!] But more importantly - **it is open source, and you can choose to deploy and manage your own Supabase instance** - which us crucial for our mission: A truly open-source, personal AI.