ASI-DiscordBot
The self-improvement Discord bot. The first service of the Adonis Self-improvement project, allowing users to keep track of their self-improvement progress through a Discord bot.
Tech
- DiscordJS NodeJS module to interact with Discord's API
- Node.js JavaScript runtime
- NPM Package manager for Node.js
- Docker Containerization platform
- guidebot Boilerplate example Discord bot
Potential
- Mongoose.js An Object Data Modeling (ODM) library for MongoDB and Node.js
Requirements
git
command line (Windows | Linux | MacOS) installednode
Version 16.x- The node-gyp build tools. This is a pre-requisite for Enmap, but also for a lot of other modules. See The Enmap Guide for details and requirements for your OS. Just follow what's in the tabbed block only, then come back here!
You also need your bot's token. This is obtained by creating an application at the Discord developer section. Check the first section of this page for more info.
Installation
Create a folder within your projects directory and run the following inside it:
git clone https://github.com/Adonis-Self-Improvement/ASI-DiscordBot.git
Once finished:
- In the folder from where you ran the git command, run
npm install
, which will install the required packages. - Rename
config.js.example
toconfig.js
, and give it the required intents and any partials you may require. - Rename
.env-example
to.env
and put in your bot token in it and save.
Starting the bot
To start the bot, in the command prompt, run the following command: node index.js
Contributing
Read up on GitHub flow for instructions on code contribution.
Setting up a development environment
Read Installation to get started.
This project uses Eslint for code formatting. Install it here and run it before making a pull request with your changes.
You can run Eslint via npx eslint --fix .
.
Build the Docker image
To be written