Merge pull request #9 from GalvinPython/dev

release: 0.1

Author: GalvinPython

.env.example

@@ -1,5 +1,5 @@
 DISCORD_TOKEN='TOKEN'
-DISCORD_WEBHOOK_URL='YOUR_WEBHOOK_HERE'
+DISCORD_TOKEN_DEV='DEV_TOKEN'
 
 MYSQL_ADDRESS='YOUR_MYSQL_SERVER_ADDRESS'
 MYSQL_PORT='YOUR_MYSQL_SERVER_PORT'

.github/dependabot.yml

@@ -6,3 +6,4 @@ updates:
       interval: "weekly"
     assignees:
       - "GalvinPython"
+    target-branch: "dev"

.github/workflows/eslint.yml

@@ -0,0 +1,28 @@
+name: ESLint Check
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  lint:
+    name: ESLint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run ESLint
+        run: npm run lint

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Galvin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,19 +1,59 @@
 # Chatr
-A Discord XP bot
+A free and open-sourced Discord XP Bot.  
+![Bot](https://img.shields.io/badge/Invite%20Chatr-5865F2?style=for-the-badge&logo=discord&logoColor=white)  
+![Discord](https://img.shields.io/discord/1249813817706283019?style=for-the-badge&logo=discord&logoColor=white&label=Support%20Server&color=%235865F2)
 
-> [!CAUTION]
-> **Chatr** is currently in development and is open-sourced. The bot is functional in this state, however it shouldn't be used
+Please report bugs in `bug-reports` on our server or open an issue on this repo!
+
+# Features
+- Earn XP from your messages!
+- Customisable xp cooldown on messages
+- Online leaderboard
+- Rankcard
+- Transfer your points from other bots!
+  - MEE6
+  - Polaris
+  - Lurkr
+  - Other bots soon
+
+> [!WARNING]
+> **Chatr** has entered Beta! (don't worry, we will deal with the headaches for you)
+
+# Developer Instructions
+
+This a project created using (Bun)[https://bun.sh]
 
 To install dependencies:
 
 ```bash
 bun install
 ```
 
-To run:
-
+Run the **API**
 ```bash
-bun run index.ts
+bun run dev:api
+```  
+Run the **Bot** 
+```bash
+bun run dev:bot
 ```
 
-This project was created using `bun init` in bun v1.1.10. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+
+# Changelog
+## Beta 0.1
+Thanks to @ToastedDev for his contributions to the bot. Here are some changes that were made
+* General formatting fixes (#8)
+* Refactored the database to be more performant (#13)
+* Added a message cooldown (#14)
+* Added a rankcard to /xp (#17)
+* User management (#19)
+* Added syncing (#24)
+
+# Roadmap
+* Rewritten site using NextJS
+* Auto-updating cached user information
+* Better privacy controls
+* Live updates
+* Track guilds and users xp
+
+Want to add more features? Join our server (linked above) and add a post to `feature-requests`

api/db/index.ts

@@ -0,0 +1,15 @@
+import mysql from "mysql2";
+
+// Create a MySQL connection pool
+export const pool = mysql.createPool({
+	host: process.env.MYSQL_ADDRESS as string,
+	port: parseInt(process.env.MYSQL_PORT as string),
+	user: process.env.MYSQL_USER as string,
+	password: process.env.MYSQL_PASSWORD as string,
+	database: process.env.MYSQL_DATABASE as string,
+});
+
+export * from './init';
+export * from './queries/guilds';
+export * from './queries/users';
+export * from './queries/updates';

api/db/init.ts

@@ -0,0 +1,64 @@
+import { pool } from ".";
+
+export async function initTables() {
+  const createGuildsTable = `
+		CREATE TABLE IF NOT EXISTS guilds (
+			id VARCHAR(255) NOT NULL PRIMARY KEY,
+			name VARCHAR(255),
+			icon VARCHAR(255),
+			members INT,
+			cooldown INT DEFAULT 30000,
+			updates_enabled BOOLEAN DEFAULT FALSE,
+			updates_channel_id VARCHAR(255) DEFAULT NULL,
+			is_in_guild BOOLEAN DEFAULT TRUE
+		)
+	`;
+  const createUsersTable = `
+		CREATE TABLE IF NOT EXISTS users (
+			id VARCHAR(255) NOT NULL,
+			guild_id VARCHAR(255) NOT NULL,
+			name VARCHAR(255),
+			nickname VARCHAR(255),
+			pfp VARCHAR(255),
+			xp INT DEFAULT 0,
+			level INT DEFAULT 0,
+			xp_needed_next_level INT,
+			progress_next_level DECIMAL(6, 2),
+			PRIMARY KEY (id, guild_id)
+		)
+	`;
+  // FOREIGN KEY (guild_id) REFERENCES guilds(id)
+  const createRolesTable = `
+		CREATE TABLE IF NOT EXISTS roles (
+			id VARCHAR(255) NOT NULL PRIMARY KEY,
+			guild_id VARCHAR(255) NOT NULL,
+			name VARCHAR(255),
+			level INT NOT NULL
+		)
+	`;
+  // FOREIGN KEY (guild_id) REFERENCES guilds(id)
+
+  pool.query(createGuildsTable, (err) => {
+    if (err) {
+      console.error("Error creating guilds table:", err);
+    } else {
+      console.log("Guilds table created");
+    }
+  });
+
+  pool.query(createUsersTable, (err) => {
+    if (err) {
+      console.error("Error creating users table:", err);
+    } else {
+      console.log("Users table created");
+    }
+  });
+
+  pool.query(createRolesTable, (err) => {
+    if (err) {
+      console.error("Error creating roles table:", err);
+    } else {
+      console.log("Roles table created");
+    }
+  });
+}

api/db/queries/guilds.ts

@@ -0,0 +1,124 @@
+import type { QueryError } from "mysql2";
+import { pool } from "..";
+
+export interface Guild {
+	id: string;
+	name: string;
+	icon: string;
+	members: number;
+	cooldown: number;
+	updates_enabled: 0 | 1;
+	updates_channel_id: string | null;
+}
+
+
+export async function getGuild(guildId: string): Promise<[QueryError, null] | [null, Guild | null]> {
+	return new Promise((resolve, reject) => {
+		pool.query("SELECT * FROM guilds WHERE id = ? AND is_in_guild = ?", [guildId, true], (err, results) => {
+			if (err) {
+				reject([err, null]);
+			} else {
+				resolve([null, (results as Guild[])[0]]);
+			}
+		});
+	});
+}
+
+export async function updateGuild(guild: Omit<Guild, "cooldown" | "updates_enabled" | "updates_channel_id">): Promise<[QueryError | null, null] | [null, Guild[]]> {
+	return new Promise((resolve, reject) => {
+		pool.query(
+			`
+			INSERT INTO guilds (id, name, icon, members, is_in_guild)
+			VALUES (?, ?, ?, ?, ?)
+			ON DUPLICATE KEY UPDATE
+				name = VALUES(name),
+				icon = VALUES(icon),
+				members = VALUES(members),
+				is_in_guild = VALUES(is_in_guild)
+			`,
+			[
+				guild.id,
+				guild.name,
+				guild.icon,
+				guild.members,
+				true,
+			],
+			(err, results) => {
+				if (err) {
+					reject([err, null]);
+				} else {
+					resolve([null, results as Guild[]]);
+				}
+			},
+		);
+	});
+}
+
+export async function removeGuild(guildId: string): Promise<[QueryError, null] | [null, true]> {
+	return new Promise((resolve, reject) => {
+		pool.query("UPDATE guilds SET is_in_guild = ? WHERE id = ?", [false, guildId], (err) => {
+			if (err) {
+				reject([err, null]);
+			} else {
+				resolve([null, true]);
+			}
+		});
+	});
+}
+
+export async function setCooldown(guildId: string, cooldown: number): Promise<[QueryError, null] | [null, Guild]> {
+  return new Promise((resolve, reject) => {
+    pool.query("UPDATE guilds SET cooldown = ? WHERE id = ?", [cooldown, guildId], (err, results) => {
+			if (err) {
+				reject([err, null]);
+			} else {
+				resolve([null, (results as Guild[])[0]]);
+			}
+		});
+  })
+}
+
+interface BotInfo {
+	total_guilds: number;
+	total_members: number;
+	user_count?: number;
+}
+
+export async function getBotInfo(): Promise<[QueryError | null, BotInfo | null]> {
+	return new Promise((resolve, reject) => {
+		pool.query("SELECT COUNT(*) AS total_guilds, SUM(members) AS total_members FROM guilds", (err, results) => {
+			if (err) {
+				reject([err, null]);
+			} else {
+				const botInfo: BotInfo = {
+					total_guilds: (results as BotInfo[])[0].total_guilds,
+					total_members: (results as BotInfo[])[0].total_members ?? 0,
+				};
+				getUsersCount()
+					.then(([userCountError, userCount]) => {
+						if (userCountError) {
+							reject([userCountError, null]);
+						} else {
+							botInfo.user_count = userCount;
+							resolve([null, botInfo]);
+						}
+					})
+					.catch((error) => {
+						reject([error, null]);
+					});
+			}
+		});
+	});
+}
+
+export async function getUsersCount(): Promise<[QueryError | null, number]> {
+	return new Promise((resolve, reject) => {
+		pool.query("SELECT COUNT(*) AS count FROM users", (err, results) => {
+			if (err) {
+				reject([err, null]);
+			} else {
+				resolve([null, (results as { count: number }[])[0].count]);
+			}
+		});
+	});
+}