Refactor: Update README, NavBar, Drizzle schema, and environment types

This commit is contained in:
Aron Malcher 2024-01-29 10:49:29 +01:00
parent 757d790e54
commit 6b07599a68
Signed by: aronmal
GPG key ID: 816B7707426FC612
4 changed files with 22 additions and 11 deletions

View file

@ -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=your_discord_client_id
VITE_DISCORD_CLIENT_SECRET=your_discord_client_secret VITE_DISCORD_CLIENT_SECRET=your_discord_client_secret
VITE_DISCORD_BOT_TOKEN=your_discord_bot_token VITE_DISCORD_BOT_TOKEN=your_discord_bot_token
VITE_DISCORD_BOT_PERMISSIONS=18977581952080
VITE_AUTH_SECRET=your_auth_secret VITE_AUTH_SECRET=your_auth_secret
VITE_DATABASE_URL=your_database_url 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).
``` #### Development
VITE_AUTH_REDIRECT_PROXY_URL=your_auth_redirect_proxy_url
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 ### 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 ## License
This project is licensed under the [MIT License](LICENSE). This project is licensed under the [GPL v3 License](LICENSE).
Happy splatting! 🦑🎮 Happy splatting! 🦑🎮

View file

@ -40,7 +40,7 @@ function NavBar() {
</ul> </ul>
<ul class="flex-row responsive thick"> <ul class="flex-row responsive thick">
<Li <Li
href="https://discord.com/api/oauth2/authorize?client_id=1024410658973941862&permissions=18977581952080&scope=bot" href={`https://discord.com/api/oauth2/authorize?client_id=${import.meta.env.VITE_DISCORD_CLIENT_ID}&permissions=${import.meta.env.VITE_DISCORD_BOT_PERMISSIONS}&scope=bot`}
name="Invite to your server" name="Invite to your server"
> >
<FontAwesomeIcon class="lower" icon={faCirclePlus} size="xl" /> <FontAwesomeIcon class="lower" icon={faCirclePlus} size="xl" />

View file

@ -1,6 +1,7 @@
import type { AdapterAccount } from "@auth/core/adapters"; import type { AdapterAccount } from "@auth/core/adapters";
import { relations } from "drizzle-orm"; import { relations } from "drizzle-orm";
import { import {
boolean,
integer, integer,
pgTable, pgTable,
primaryKey, primaryKey,
@ -71,7 +72,7 @@ export const matchPlannings = pgTable("match_planning", {
roleId: varchar("role_id", { length: 20 }).notNull(), roleId: varchar("role_id", { length: 20 }).notNull(),
opponentName: varchar("opponent_name", { length: 100 }).notNull(), opponentName: varchar("opponent_name", { length: 100 }).notNull(),
messageId: varchar("message_id", { length: 20 }).notNull(), messageId: varchar("message_id", { length: 20 }).notNull(),
ts: timestamp("ts").notNull(), utc_ts: timestamp("utc_ts").notNull(),
guildId: varchar("guild_id", { length: 20 }) guildId: varchar("guild_id", { length: 20 })
.notNull() .notNull()
.references(() => guilds.id, { onDelete: "cascade" }), .references(() => guilds.id, { onDelete: "cascade" }),
@ -107,6 +108,7 @@ export const timePlannings = pgTable("time_planning", {
}), }),
channelId: varchar("channel_id", { length: 20 }).notNull(), channelId: varchar("channel_id", { length: 20 }).notNull(),
target_interval: smallint("target_interval").notNull(), target_interval: smallint("target_interval").notNull(),
roles: boolean("roles").notNull(),
isAvailableRoleId: varchar("is_available_role_id", { length: 20 }), isAvailableRoleId: varchar("is_available_role_id", { length: 20 }),
wantsToBeNotifieRoledId: varchar("wants_to_be_notified_role_id", { wantsToBeNotifieRoledId: varchar("wants_to_be_notified_role_id", {
length: 20, length: 20,

4
src/types/env.d.ts vendored
View file

@ -1,9 +1,10 @@
/// <reference types="vinxi/client" /> /// <reference types="vinxi/client" />
interface ImportMetaEnv { interface ImportMetaEnv {
readonly VITE_DISCORD_CLIENT: string; readonly VITE_DISCORD_CLIENT_ID: string;
readonly VITE_DISCORD_CLIENT_SECRET: string; readonly VITE_DISCORD_CLIENT_SECRET: string;
readonly VITE_DISCORD_BOT_TOKEN: string; readonly VITE_DISCORD_BOT_TOKEN: string;
readonly VITE_DISCORD_BOT_PERMISSIONS: string;
readonly VITE_AUTH_SECRET: string; readonly VITE_AUTH_SECRET: string;
readonly VITE_AUTH_REDIRECT_PROXY_URL: string | undefined; readonly VITE_AUTH_REDIRECT_PROXY_URL: string | undefined;
@ -11,6 +12,7 @@ interface ImportMetaEnv {
readonly VITE_DATABASE_URL: string; readonly VITE_DATABASE_URL: string;
} }
// eslint-disable-next-line no-unused-vars
interface ImportMeta { interface ImportMeta {
readonly env: ImportMetaEnv; readonly env: ImportMetaEnv;
} }