Feat: docs commands

.env.example

@@ -2,3 +2,4 @@ TOKEN=
 CLIENT_ID=
 GUILD_ID=
 NODE_ENV=
+DB_FILE_NAME="data.db"

.gitignore

@@ -5,4 +5,6 @@ dist/
 !.env.example
 .vscode/
 .idea/
-.DS_Store
+.DS_Store
+data.db
+config.json

README.md

@@ -17,3 +17,17 @@ Official Discord Bot for <a href="https://overextended.dev">Overextended</a>.
 ## Disclaimer
 
 This bot is still in development and is intended as a future replacement for the current bot used in the Overextended Discord. If you plan to use it for your own Discord, please review the code to tailor it to your needs. **We will not provide support for this bot**; the code is shared for transparency and because most Overextended projects are open-source.
+
+## Database Management
+
+We use **Drizzle Kit** to manage schema migrations and inspect the database. All CLI interactions run through `nubx drizzle-kit ...`
+
+| Command | Action |
+| --- | --- |
+| `nubx drizzle-kit generate` | Creates a new SQL migration based on schema changes. |
+| `nubx drizzle-kit migrate` | Executes pending SQL migrations against the database. |
+| `nubx drizzle-kit push` | Directly syncs schema changes without migration files. |
+| `nubx drizzle-kit studio` | Opens a web-based UI to view and edit database rows. |
+
+> [!WARNING]
+> `push` directly alters your database schema without generating version-controlled SQL migration files. Use this primarily in local development.

config.template.json

@@ -0,0 +1,12 @@
+{
+  "roles": {
+    "moderation": ["role_id", "role_id"],
+    "blacklisted": ["role_id"],
+    "member": ["role_id"]
+  },
+  "channels": {
+    "actionlog": "channel_id",
+    "messagelog": "channel_id",
+    "joinleavelog": "channel_id"
+  }
+}

drizzle.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from "drizzle-kit";
+import { env } from "./src/env"
+
+export default defineConfig({
+  dialect: "sqlite",
+  out: './drizzle',
+  schema: "./src/db/schema.ts",
+  dbCredentials: {
+    url: env.DB_FILE_NAME ? `file:${env.DB_FILE_NAME}` : 'file:data.db',
+  }
+});

drizzle/0000_productive_guardian.sql

@@ -0,0 +1,50 @@
+CREATE TABLE `bans` (
+	`id` integer PRIMARY KEY AUTOINCREMENT NOT NULL,
+	`reason` text NOT NULL,
+	`issuer_id` text(20) NOT NULL,
+	`target_id` text(20) NOT NULL,
+	`issued_at` integer DEFAULT (unixepoch()) NOT NULL,
+	`revoked_at` integer,
+	`revoked_by` text(20),
+	FOREIGN KEY (`issuer_id`) REFERENCES `users`(`id`) ON UPDATE cascade ON DELETE restrict,
+	FOREIGN KEY (`target_id`) REFERENCES `users`(`id`) ON UPDATE cascade ON DELETE restrict,
+	FOREIGN KEY (`revoked_by`) REFERENCES `users`(`id`) ON UPDATE cascade ON DELETE restrict
+);
+--> statement-breakpoint
+CREATE INDEX `idx_bans_targetid` ON `bans` (`target_id`);--> statement-breakpoint
+CREATE INDEX `idx_bans_issuerid` ON `bans` (`issuer_id`);--> statement-breakpoint
+CREATE TABLE `kicks` (
+	`id` integer PRIMARY KEY AUTOINCREMENT NOT NULL,
+	`reason` text NOT NULL,
+	`issuer_id` text(20) NOT NULL,
+	`target_id` text(20) NOT NULL,
+	`issued_at` integer DEFAULT (unixepoch()) NOT NULL,
+	`revoked_at` integer,
+	`revoked_by` text(20),
+	FOREIGN KEY (`issuer_id`) REFERENCES `users`(`id`) ON UPDATE cascade ON DELETE restrict,
+	FOREIGN KEY (`target_id`) REFERENCES `users`(`id`) ON UPDATE cascade ON DELETE restrict,
+	FOREIGN KEY (`revoked_by`) REFERENCES `users`(`id`) ON UPDATE cascade ON DELETE restrict
+);
+--> statement-breakpoint
+CREATE INDEX `idx_kicks_targetid` ON `kicks` (`target_id`);--> statement-breakpoint
+CREATE INDEX `idx_kicks_issuerid` ON `kicks` (`issuer_id`);--> statement-breakpoint
+CREATE TABLE `users` (
+	`id` text(20) PRIMARY KEY NOT NULL,
+	`joined_at` integer DEFAULT CURRENT_TIMESTAMP NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `warns` (
+	`id` integer PRIMARY KEY AUTOINCREMENT NOT NULL,
+	`reason` text NOT NULL,
+	`issuer_id` text(20) NOT NULL,
+	`target_id` text(20) NOT NULL,
+	`issued_at` integer DEFAULT (unixepoch()) NOT NULL,
+	`revoked_at` integer,
+	`revoked_by` text(20),
+	FOREIGN KEY (`issuer_id`) REFERENCES `users`(`id`) ON UPDATE cascade ON DELETE restrict,
+	FOREIGN KEY (`target_id`) REFERENCES `users`(`id`) ON UPDATE cascade ON DELETE restrict,
+	FOREIGN KEY (`revoked_by`) REFERENCES `users`(`id`) ON UPDATE cascade ON DELETE restrict
+);
+--> statement-breakpoint
+CREATE INDEX `idx_warns_targetid` ON `warns` (`target_id`);--> statement-breakpoint
+CREATE INDEX `idx_warns_issuerid` ON `warns` (`issuer_id`);