docs + guild model setup

src/models/guild.ts

@@ -0,0 +1,29 @@
+import { Schema, model } from "mongoose";
+
+export interface IGuild {
+    guildID: string,
+    welcome_enabled: boolean,
+    welcome_channel: string,
+    welcome_join_role: string,
+    xp_enabled: boolean,
+    ignored_xp_channels: string[],
+    ignored_xp_roles: string[],
+    blacklisted_xp_users: string[],
+    inserted_at: Date,
+    updated_at: Date
+}
+
+const guildSchema = new Schema<IGuild>({
+    guildID: String,
+    welcome_enabled: Boolean,
+    welcome_channel: String,
+    welcome_join_role: String,
+    xp_enabled: Boolean,
+    ignored_xp_channels: [String],
+    ignored_xp_roles: [String],
+    blacklisted_xp_users: [String],
+    inserted_at: Date,
+    updated_at: Date
+});
+
+export default model<IGuild>('guilds', guildSchema);

src/types/routes.types.ts

@@ -1,5 +1,8 @@
-import {Request, Response, NextFunction } from 'express';
+import { Request, Response, NextFunction } from 'express';
 
+/*
+    HttpMethod to have autocomplete for the HTTP methods
+*/
 type HttpMethod = 'get' | 'post' | 'put' | 'delete';
 
 interface ParamsDictionary {
@@ -12,6 +15,9 @@ type ControllerFunction<T> = (
     next: NextFunction
 ) => void;
 
+/*
+    Object to define the route structure
+*/
 export type Route<T> = {
     method: HttpMethod;
     path: string;