From 6fb563502a35f7dbf7c6def314a6fb6dccffeae8 Mon Sep 17 00:00:00 2001 From: aronmal Date: Thu, 28 Mar 2024 16:59:16 +0100 Subject: [PATCH] chore: Updated README and env types --- README.md | 28 +++++++++++++++------------- src/types/env.d.ts | 3 +-- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 5618e6f..3d0d49b 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ To get started with li'l Judd, follow the instructions below. 2. Install dependencies: ```bash - cd lil-judd + cd liljudd-website # Install pnpm if not already installed npm i -g pnpm @@ -50,27 +50,29 @@ To get started with li'l Judd, follow the instructions below. VITE_DISCORD_CLIENT_SECRET=your_discord_client_secret VITE_DISCORD_BOT_TOKEN=your_discord_bot_token VITE_DISCORD_OAUTH2_PERMISSIONS=18977581952080 - - VITE_AUTH_SECRET=your_auth_secret - + VITE_AUTH_REDIRECT_URL=your_redirect_url VITE_DATABASE_URL=your_database_url ``` -Recieve your discord applications `CLIENT_ID` & `CLIENT_SECRET`, as well as the bot token from the [Applications dashboard](https://discord.com/developers/applications/). + Recieve your discord applications `CLIENT_ID`, `CLIENT_SECRET` & `BOT_TOKEN` from the [Applications dashboard](https://discord.com/developers/applications/). -Your `VITE_AUTH_REDIRECT_URL` should look like this: `https:///api/auth/callback/discord`. + Your `VITE_AUTH_REDIRECT_URL` should look like this: `https:///api/auth/callback/discord`. -Composite your `VITE_DATABASE_URL` like [`postgres://postgres:adminadmin@0.0.0.0:5432/db`](https://orm.drizzle.team/docs/get-started-postgresql#postgresjs). + Composite your `VITE_DATABASE_URL` like [`postgres://username:password@hostname:5432/databasename`](https://orm.drizzle.team/docs/get-started-postgresql#postgresjs). -#### Development + #### Development -The duplicate `DATABASE_URL` is only needed for Drizzle Studio. + The duplicate `DATABASE_URL` is only needed for Drizzle Studio. -``` -VITE_AUTH_REDIRECT_PROXY_URL=your_auth_redirect_proxy_url + ``` + # Drizzle Studio & Tests + DATABASE_URL=your_database_url -DATABASE_URL=your_database_url -``` + #Tests + VITE_DISCORD_CLIENT_ID=your_discord_client_id + VITE_DISCORD_CLIENT_SECRET=your_discord_client_secret + VITE_DISCORD_BOT_TOKEN=your_discord_bot_token + ``` ### Usage diff --git a/src/types/env.d.ts b/src/types/env.d.ts index 98ff518..e5f913c 100644 --- a/src/types/env.d.ts +++ b/src/types/env.d.ts @@ -6,8 +6,7 @@ interface ImportMetaEnv { readonly VITE_DISCORD_BOT_TOKEN: string; readonly VITE_DISCORD_OAUTH2_PERMISSIONS: string; - readonly VITE_AUTH_SECRET: string; - readonly VITE_AUTH_REDIRECT_PROXY_URL: string | undefined; + readonly VITE_AUTH_REDIRECT_URL: string; readonly VITE_DATABASE_URL: string; }