To become a hard working developer for this project, join Electrium Mobility and join our Discord server to get started ASAP!
- Clone this project
git clone https://github.com/Electrium-Mobility/discord-bot.git
- Install node and npm modules
ensure you are using Node v16.11.0 or higher for macs :
brew install node
npm i
- Obtain config tokens
Go into Discord, find the pinned messages for config.json and credentials.json in the config-and-credentials channel. Download and put into your directory.
- Run this command to deploy commands:
node deploy-commands.js
- Run bot with:
node .
When developing, it is recommended to use nodemon:
nodemon .
See our Clickup document for more info on how to use the various commands!
If you feel daunted by all of this, no worries! This guide will help you get an understanding of how this flow works.
Get started by connecting your Github account to Clickup if you haven't done so yet.
Head over to the Clickup Kanban board and see if there is anything that you can tackle. Have an idea that's not on the board? Create it yourself and start working on it! Follow the instructions on Clickup on how to create your own branch from the Kanban board.
Go ham! Type and program to your heart's content! This part might take the longest and that's okay! Being slow is all part of the learning progress and it gets better the more you code. Don't forget to test everything before moving onto the next step!
Once everything is looking good, it's time to merge it to the main branch. It's like writing a book. You just finished writing an amazing story and it's time to have it sent to a publisher. A pull request (PR) says "Hey I'm ready to publish my contributions!" Just like how publishing a book works, after putting in a PR, your code will be reviewed by a team member to verify if everything looks good or not. Some things may be pointed out for some revision, but eventually, your PR will be approved and then you can merge into the main branch!
How did that feel? Exciting? Exhilarating? There's always more work to be done to this bot, so how about starting again from step 1?
Clickup stores all the documentations you will need to contribute to this project! It also has this project's Kanban board, where it tracks the development progress of this project. Feel free to open a ticket of your own and start working!
Discord.js has awesome documentation and resources for beginners to start contributing. They even have their own Discord server where you can consult experts for any Discord.js related questions!
In addition, they have an excellent guide that you can follow to understand how the codebase works.
Refer to this documentation if you ever find yourself implementing features relating to voice calls.
New to JavaScript? Mozilla's documentation is a terrific place to head to! Good alternatives include, but are not limited to: W3Schools, Codecademy, and The Modern JavaScript Tutorial.