This repo contains the starter code needed to follow along with the Building with Node.js event. To run this project, you will need to have Node.js installed on your machine. You can download Node.js from here. The LTS version is recommended.
Some of the code here is based off of the excellent examples in the discord.js documentation and the discord.js guide. If you're looking for more examples on how to improve this bot, check out those resources.
We ran out of time during the workshop to fully explain this completed code, so we encourage you to figure out how we created the GitHub Todo Board (located in githubBoard.js) and how we created the Message Embed for the /github command.
Some resources that should help you better understand some of the concepts used in this project can be found here:
- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises
- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment
- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Arrow_functions#description
- https://developer.mozilla.org/en-US/docs/Web/API/setInterval
- https://discordjs.guide/creating-your-bot/slash-commands.html#individual-command-files
- https://discordjs.guide/popular-topics/embeds.html
- https://github.com/octokit/octokit.js#usage
We highly encourage that you read all of the bot's code and reference these resources to better understand what is going on. This bot is rudimentary in nature but serves as a good starting point for you to build your own Discord bot. Make it your own! If you ever don't understand something or are wondering how you can implement some functionality into your bot, Google your question and you're sure to find an answer.
Clone the repo and install the dependencies with these commands in your terminal:
git clone https://github.com/gdscuic/building-with-nodejs.git
cd building-with-nodejs
npm installCopy the .env.example file to .env and fill in the values. You will need to create a new Discord application on the Discord Developer Portal. The DISCORD_TOKEN can be found on the Bot page. The DISCORD_CLIENT_ID can be found on the OAuth page.
DISCORD_GUILD_ID can be found by enabling Developer Mode in Discord. You can do this by going to Settings > Advanced > Developer Mode. Then, right click on the server you'd like to have the commands in and click "Copy ID".
DISCORD_BOARD_CHANNEL_ID and DISCORD_BOARD_MESSAGE_ID are expected to be the channel and message ID of the message that will be updated with the Todo board. You can get these by right clicking on the channel and message and clicking "Copy ID". How these values are used are explained in the event.
GITHUB_TOKEN is entirely optional and can be used if you encouter rate limits while using the GitHub API.
Once you've filled out the values required in the .env, you should post your commands to Discord with this command:
node postCommands.jsYou should run this command if you ever add new commands or update the structure of your commands (such as adding more options/arguments).
You can then run the bot with this command:
npm run startindex.js contains the main code for the Discord client. Events are handled here. common.js contains code that is used in multiple places.
postCommands.js contains code that will post the commands to Discord. This is ran once to let Discord know what commands are available in your bot.
/commands contains code that will be ran when a user uses a chat command. /commands/hello.js contains an example on how commands are structured for our Discord bot.
githubBoard.js has the code that will be run hourly to update the Todo board assuming it has been correctly set up in the .env file.