removed or updated commented-out code, removed unused files, updated README

Author: nonsensetwice

.env.template

@@ -14,10 +14,5 @@ MONGODB_PASS=
 MONGODB_CLUSTER=
 DB_NAME=
 
-# Pino-Loki
-LOKI_HOST=
-LOKI_USERNAME=
-LOKI_PASSWORD=
-
 # Sentry
 SENTRY_IO_DSN=

README.md

@@ -1,2 +1,42 @@
 # spades
 discord.js bot template
+
+This is a basic discord bot template written in JS, running in Node v18+. The bot is built with minimal dependencies:
+- [discord.js](https://discord.js.org) library to interact with the [Discord API](https://discord.com/developers/docs/intro),
+- [sapphire](https://www.sapphirejs.dev), a command framework as an extension of discord.js,
+- [esLint](https://eslint.org), a code linter for keeping code consistent across all files,
+- [dotenv](https://www.dotenv.org/docs) for configuring and utilizing `.env` files,
+- a [mongodb](https://mongodb.github.io/node-mongodb-native/) node driver, for connecting and interaction with an instance of MongoDB Atlas,
+- [pino](https://getpino.io/), a lightweight logger, and
+- [sentry](https://sentry.io) for error tracing.
+
+the idea is to get a bot up a running with logging, error tracing, database connectivity, and a solid command structure. The utilities are barebones--build them up or swap them out at your leisure.  
+  
+## getting started
+tap the "Use this template" and create a new repository. copy the `.env.template`, rename it to `.env`, and fill out the fields with your credentials. you'll need:
+- a bot token, application id, and public key from Discord. you can find those in the [Discord Developer Portal](https://discord.com/developers) when you create an app,
+- a URI connection string from [MongoDB Atlas](https://mongodb.com), and
+- a client key--known as a "DSN"--from [Sentry](https://sentry.io).  
+
+you may also want to install Docker and Docker Compose, if you want to run the bot in a container.  
+  
+once all the fields are filled out, you can:
+```
+npm install
+```
+then
+```
+npm run start
+```
+to run the bot locally through Node in your dev environment, or:
+```
+docker compose up
+```
+to run the bot in a Docker container.  
+  
+if all works well, you should see your bot active in your Discord server once you invite it. To test it, run the `/ping` command.  
+  
+## ongoing development
+active development will take place as libraries and frameworks are updated, or to improve error tracing, logging, and app monitoring. if you're interested in contributing to the source code or find a bug to report, reach out to me on [twitter](https://twitter.com/nonsensecodes); issue guides will be forthcoming.
+  
+and that's it! happy building!

docker-compose.debug.yml

@@ -8,6 +8,23 @@ services:
       dockerfile: ./Dockerfile
     environment:
       NODE_ENV: development
+      APP_NAME: ${spades}
+
+      # Discord application
+      DISCORD_BOT_TOKEN: ${DISCORD_BOT_TOKEN}
+      DISCORD_BOT_PUBLIC_KEY: ${DISCORD_BOT_PUBLIC_KEY}
+      DISCORD_BOT_APPLICATION_ID: ${DISCORD_BOT_APPLICATION_ID}
+      DISCORD_BOT_ACTIVITY: ${DISCORD_BOT_ACTIVITY}
+
+      # MongoDB
+      MONGODB_PREFIX: ${MONGODB_PREFIX}
+      MONGODB_USERNAME: ${MONGODB_USERNAME}
+      MONGODB_PASS: ${MONGODB_PASS}
+      MONGODB_CLUSTER: ${MONGODB_CLUSTER}
+      DB_NAME: ${DB_NAME}
+
+      # Sentry
+      SENTRY_IO_DSN: ${SENTRY_IO_DSN}
     ports:
       - 9229:9229
     command: ["node", "--inspect=0.0.0.0:9229", "src/app/app.js"]

docker-compose.yml

@@ -23,10 +23,5 @@ services:
       MONGODB_CLUSTER: ${MONGODB_CLUSTER}
       DB_NAME: ${DB_NAME}
 
-      # Pino-Loki
-      LOKI_HOST: ${LOKI_HOST}
-      LOKI_USERNAME: ${LOKI_USERNAME}
-      LOKI_PASSWORD: ${LOKI_PASSWORD}
-
       # Sentry
       SENTRY_IO_DSN: ${SENTRY_IO_DSN}