The Skill Tree Discord Bot allows users to keep track of their self-improvement progress effortlessly through Discord.
- DiscordJS NodeJS module to interact with Discord's Data
- Node.js JavaScript runtime
- NPM Package manager for Node.js
- guidebot Boilerplate example Discord bot
- Mongoose.js An Object Data Modeling (ODM) library for MongoDB and Node.js
gitcommand line (Windows | Linux | MacOS) installednodeVersion 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.
Create a folder within your projects directory and run the following inside it:
git clone https://github.com/Project-Skill-Tree/Skill-Tree-Discord-Bot.git
Once finished:
- In the folder from where you ran the git command, run
npm install, which will install the required packages. - Make sure you're using node.js
v16.14.2 - Rename
.env-exampleto.envand put each key inside as follows- DISCORD_TOKEN - Your bot token
- OWNER - Your discord ID
- API_URL - The URL of your API instance (for example: http://localhost:3000/v1, must include /v1/ at the end)
- API_KEY - The API key (Can be anything, shared between bot and API)
- GOOGLE_API_KEY - Google maps API key
- Set up the API
- Set up the editor
To start the bot, in the command prompt, run the following command:
node index.js
Read up on GitHub flow for instructions on code contribution. Read the documentation wiki
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 ..