SimplyStats

About

SimplyStats is a Discord bot created for Discord's 0th Hackathon. It allows you to build in-depth statistics about your server, from user growth to messages sent per hour and much much more.

Invite the bot to your Discord Guild by going here!

The bot is written in TypeScript, using Discord.js and Klasa. It is split into two main parts:

modules
- There are the main "modules" of the bot, in order to keep everything more modular
core
- This is the main bot core. It handles the registration of all modules, and the actual connection to Discords' Gateway/REST API
- It is also split into two parts by itself:
  - bot
    - The actual bot core, which handles every incoming event.
  - web
    - The web UI for the bot (soon™️)

How to run the bot

First thing you'll need is node.js with a version greater than 12! Install it using your operating systems instructions.

You'll also want to get RethinkDB and ElasticSearch. We also have a docker-compose file if you want to use Docker for hosting the bot.

Clone the repository by using git

# Use https if you don't have SSH keys setup
git clone git@github.com:vladfrangu/SimplyStats.git

Go into the directory for the bot and install all dependencies

# cd into the bot directory
cd SimplyStats

# Or yarn
npm i

Copy the config.ts.example file to config.ts, fill in all the values, then run

npm run ts:compile

# For yarn users

yarn ts:compile

Then, just run the bot!

node .

If you're using Docker and Docker Compose, you just need to run

docker-compose up

Contributing

Contributing instructions are TBD

Authors

Here are the amazing people who are working on this bot in order to bring you the best experience while using our bot: