From 6b07599a683dee78567240fde4b242f9486fcce8 Mon Sep 17 00:00:00 2001 From: aronmal Date: Mon, 29 Jan 2024 10:49:29 +0100 Subject: [PATCH] Refactor: Update README, NavBar, Drizzle schema, and environment types --- README.md | 23 +++++++++++++++-------- src/components/NavBar.tsx | 2 +- src/drizzle/schema.ts | 4 +++- src/types/env.d.ts | 4 +++- 4 files changed, 22 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 94099da..1fa87ab 100644 --- a/README.md +++ b/README.md @@ -49,23 +49,30 @@ To get started with li'l Judd, follow the instructions below. VITE_DISCORD_CLIENT=your_discord_client_id VITE_DISCORD_CLIENT_SECRET=your_discord_client_secret VITE_DISCORD_BOT_TOKEN=your_discord_bot_token + VITE_DISCORD_BOT_PERMISSIONS=18977581952080 VITE_AUTH_SECRET=your_auth_secret VITE_DATABASE_URL=your_database_url ``` - #### Development +Recieve your discord applications client id & secret, as well as the bot token from the [Applications dashboard](https://discord.com/developers/applications/). - Specify `VITE_AUTH_REDIRECT_PROXY_URL` only if necessary, particularly when setting up a reverse proxy to test authentication with callbacks to your development box. [Auth.js Docs Reference](https://authjs.dev/reference/nextjs/#redirectproxyurl) +How to generate your `VITE_AUTH_SECRET` with [`openssl rand -base64 32`](https://authjs.dev/reference/core#secret). - The duplicate `DATABASE_URL` is only needed for Drizzle Studio. +Composite your `VITE_DATABASE_URL` like [`postgres://postgres:adminadmin@0.0.0.0:5432/db`](https://orm.drizzle.team/docs/get-started-postgresql#postgresjs). - ``` - VITE_AUTH_REDIRECT_PROXY_URL=your_auth_redirect_proxy_url +#### Development - DATABASE_URL=your_database_url - ``` +Specify `VITE_AUTH_REDIRECT_PROXY_URL` only if necessary, particularly when setting up a reverse proxy to test authentication with callbacks to your development box. [Auth.js Docs Reference](https://authjs.dev/reference/nextjs/#redirectproxyurl) + +The duplicate `DATABASE_URL` is only needed for Drizzle Studio. + +``` +VITE_AUTH_REDIRECT_PROXY_URL=your_auth_redirect_proxy_url + +DATABASE_URL=your_database_url +``` ### Usage @@ -120,6 +127,6 @@ If you'd like to contribute to li'l Judd, feel free to open an issue or submit a ## License -This project is licensed under the [MIT License](LICENSE). +This project is licensed under the [GPL v3 License](LICENSE). Happy splatting! 🦑🎮 diff --git a/src/components/NavBar.tsx b/src/components/NavBar.tsx index bdd9cf2..fffda85 100644 --- a/src/components/NavBar.tsx +++ b/src/components/NavBar.tsx @@ -40,7 +40,7 @@ function NavBar() {