diff --git a/README.md b/README.md index 580438f6..bf2cbcf8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- unSAGED logo + unSAGED logo

[![Join our Discord](https://discordapp.com/api/guilds/1124558062171209771/widget.png?style=banner2)](https://discord.gg/rMH2acSEzq) @@ -59,8 +59,8 @@ Follow the installation instructions in the [Getting Started](https://unsaged.co ## 🚀 Upgrading unSAGED -* On November 13th, 2023, we released a major update to unSAGED, which introduced more settings to the conversation. It requires that you update some database table columns. If you are upgrading from a version of unSAGED released before this date, you will need to run the [Upgrade Script](./packages/unsaged/db/UpgradeScript.sql) in the [Supabase SQL editor](https://app.supabase.com/project/_/sql). -* On November 16th, 2023, we released a major update to unSAGED, which converts this repo into monorepo to support the documentation website. It requires that you change a setting in your Vercel project, if you have one. If you do have one, you need to set `packages/unsaged` as the [Root Directory](https://vercel.com/docs/deployments/configure-a-build#root-directory) in your Vercel project's settings. +* On November 13th, 2023, we released a major update to unSAGED, which introduced more settings to the conversation. It requires that you update some database table columns. If you are upgrading from a version of unSAGED released before this date, you will need to run the [Upgrade Script](./apps/unsaged/db/UpgradeScript.sql) in the [Supabase SQL editor](https://app.supabase.com/project/_/sql). +* On November 16th, 2023, we released a major update to unSAGED, which converts this repo into monorepo to support the documentation website. It requires that you change a setting in your Vercel project, if you have one. If you do have one, you need to set `apps/unsaged` as the [Root Directory](https://vercel.com/docs/deployments/configure-a-build#root-directory) in your Vercel project's settings. ## 📝 License @@ -74,13 +74,13 @@ We welcome contributions to the unSAGED project! If you're interested in contrib ## 📸 Screenshots -![Screenshot-1](./packages/unsaged/public/screenshots/screenshot-1.png) +![Screenshot-1](./apps/unsaged/public/screenshots/screenshot-1.png) -![Screenshot-2](./packages/unsaged/public/screenshots/screenshot-2.png) +![Screenshot-2](./apps/unsaged/public/screenshots/screenshot-2.png) -![Screenshot-4](./packages/unsaged/public/screenshots/screenshot-4.png) +![Screenshot-4](./apps/unsaged/public/screenshots/screenshot-4.png) -![Screenshot-5](./packages/unsaged/public/screenshots/screenshot-5.png) +![Screenshot-5](./apps/unsaged/public/screenshots/screenshot-5.png) ## 📚 Built With diff --git a/apps/docs/docs/configuration/anthropic-configuration.md b/apps/docs/docs/configuration/anthropic-configuration.md index ff34714b..deb379db 100644 --- a/apps/docs/docs/configuration/anthropic-configuration.md +++ b/apps/docs/docs/configuration/anthropic-configuration.md @@ -8,7 +8,7 @@ sidebar_position: 7 To give everyone using your instance of unSAGED access to Anthropic models like Claude 2, set the following environment variables: -```sh title="packages/unsaged/.env.local" +```sh title="apps/unsaged/.env.local" ANTHROPIC_API_KEY=your_anthropic_api_key ``` diff --git a/apps/docs/docs/configuration/azure-configuration.md b/apps/docs/docs/configuration/azure-configuration.md index f3d10c7d..2ae00f21 100644 --- a/apps/docs/docs/configuration/azure-configuration.md +++ b/apps/docs/docs/configuration/azure-configuration.md @@ -8,7 +8,7 @@ To give everyone using your instance of unSAGED access to OpenAI models hosted o ## Global Access Configuration -```sh title="packages/unsaged/.env.local" +```sh title="apps/unsaged/.env.local" OPENAI_API_URL=the_url_of_your_azure_api OPENAI_API_KEY=your_api_key OPENAI_API_TYPE=azure diff --git a/apps/docs/docs/configuration/how-it-works.md b/apps/docs/docs/configuration/how-it-works.md index 714abff3..1b677ef2 100644 --- a/apps/docs/docs/configuration/how-it-works.md +++ b/apps/docs/docs/configuration/how-it-works.md @@ -6,6 +6,6 @@ sidebar_position: 1 To make it easy to configure unSAGED, we use environment variables as the main configuration format. This allows anyone deploying unSAGED to Vercel to easily configure their instance of unSAGED without having to modify the source code. -When building locally, use `packages/unsaged/.env.local` to set your environment variables. When deploying to Vercel, use the Vercel dashboard to set your environment variables. +When building locally, use `apps/unsaged/.env.local` to set your environment variables. When deploying to Vercel, use the Vercel dashboard to set your environment variables. -Also, set `packages/unsaged` as the [Root Directory](https://vercel.com/docs/deployments/configure-a-build#root-directory) in your Vercel project's settings. +Also, set `apps/unsaged` as the [Root Directory](https://vercel.com/docs/deployments/configure-a-build#root-directory) in your Vercel project's settings. diff --git a/apps/docs/docs/configuration/ollama-configuration.md b/apps/docs/docs/configuration/ollama-configuration.md index c7f1cdec..5964622b 100644 --- a/apps/docs/docs/configuration/ollama-configuration.md +++ b/apps/docs/docs/configuration/ollama-configuration.md @@ -12,7 +12,7 @@ To give everyone using your instance of unSAGED access to self hosted models lik Use `127.0.0.1` instead of `localhost` if you are running locally. ::: -```sh title="packages/unsaged/.env.local" +```sh title="apps/unsaged/.env.local" OLLAMA_HOST="http://127.0.0.1:11434" ``` diff --git a/apps/docs/docs/configuration/openai-configuration.md b/apps/docs/docs/configuration/openai-configuration.md index 650b98ad..f7775815 100644 --- a/apps/docs/docs/configuration/openai-configuration.md +++ b/apps/docs/docs/configuration/openai-configuration.md @@ -8,7 +8,7 @@ sidebar_position: 5 To give everyone using your instance of unSAGED access to OpenAI models like GPT-4, set the following environment variables: -```sh title="packages/unsaged/.env.local" +```sh title="apps/unsaged/.env.local" OPENAI_API_KEY=your_openai_api_key ``` diff --git a/apps/docs/docs/configuration/palm-configuration.md b/apps/docs/docs/configuration/palm-configuration.md index d5fc15a5..4d2cfa75 100644 --- a/apps/docs/docs/configuration/palm-configuration.md +++ b/apps/docs/docs/configuration/palm-configuration.md @@ -8,7 +8,7 @@ sidebar_position: 8 To give everyone using your instance of unSAGED access to Google's PaLM 2 models like Bard, set the following environment variables: -```sh title="packages/unsaged/.env.local" +```sh title="apps/unsaged/.env.local" PALM_API_KEY=your_palm_api_key ``` diff --git a/apps/docs/docs/getting-started/installation.md b/apps/docs/docs/getting-started/installation.md index 8f686d66..1bf453e3 100644 --- a/apps/docs/docs/getting-started/installation.md +++ b/apps/docs/docs/getting-started/installation.md @@ -12,7 +12,7 @@ git clone https://github.com/jorge-menjivar/unSAGED.git ## Generate Supabase Tables -Run the [Generation Script](https://github.com/jorge-menjivar/unSAGED/packages/unsaged/db/GenerationScript.sql) in the [Supabase SQL editor](https://app.supabase.com/project/_/sql). +Run the [Generation Script](https://github.com/jorge-menjivar/unSAGED/apps/unsaged/db/GenerationScript.sql) in the [Supabase SQL editor](https://app.supabase.com/project/_/sql). This will do the following: @@ -29,18 +29,18 @@ More information [here](https://authjs.dev/reference/adapter/supabase#expose-the Then copy the output and save it for the next step. -## Switch to the `packages/unsaged` directory +## Switch to the `apps/unsaged` directory -The `packages/unsaged` directory contains the unSAGED app. All following commands should be run from this directory. +The `apps/unsaged` directory contains the unSAGED app. All following commands should be run from this directory. ```sh -cd packages/unsaged +cd apps/unsaged ``` ## Set Environment Variables -The `.env.local` file is the main configuration file for unSAGED. It should be located in the `packages/unsaged` directory of the project. -Create the `packages/unsaged/.env.local` file to set your environment variables. +The `.env.local` file is the main configuration file for unSAGED. It should be located in the `apps/unsaged` directory of the project. +Create the `apps/unsaged/.env.local` file to set your environment variables. ### Set Auth Secret @@ -52,7 +52,7 @@ openssl rand -base64 32 Set the `NEXTAUTH_SECRET` environment variable to the secret you just created. -```sh title="packages/unsaged/.env.local" +```sh title="apps/unsaged/.env.local" NEXTAUTH_SECRET=my_secret ``` @@ -60,7 +60,7 @@ See [Auth.js Documentation](https://next-auth.js.org/configuration/options#nexta ### Set Supabase Variables -```sh title="packages/unsaged/.env.local" +```sh title="apps/unsaged/.env.local" NEXT_PUBLIC_SUPABASE_URL="https://xxxxxxxxxxxxxxxx.supabase.co" NEXT_PUBLIC_SUPABASE_ANON_KEY=supabase_anon_key SUPABASE_JWT_SECRET=supabase_jwt_secret @@ -96,6 +96,6 @@ To run in production, you will need to set the following environment variable. See [Auth.js Documentation](https://next-auth.js.org/configuration/options#nextauth_url) for more information. -```sh title="packages/unsaged/.env.local" +```sh title="apps/unsaged/.env.local" NEXTAUTH_URL=https://yourdomain.com ```