StatsBot - A Discord Bot to gather data from public APIs

[!NOTE] This project does participate in the Hacktoberfest event!

A Discord bot which provides various commands to get data from public APIs. This project is using the discord.js library and public APIs from this list or other ressources.

:sparkles: How to contribute

[!WARNING] For the duration of Hacktoberfest, only one issue/pull request per person will be accepted. If you want to contribute more, please look for other repositories here and keep contributing ❤️

• Navigate to an open issue and ask to be assigned to it (or create one yourself)
• After you are assigned, fork the repository and create a new branch
• Make your changes on the new branch and commit them
• Create a pull request and wait for it to be reviewed
• Thats it!

For more information check out the Contribution Guidelines

:white_check_mark: Available commands

:wrench: Installation

Prerequisites

• Node.js (v16.14.0 or higher)
• Discord Account

Project Setup

1. Fork or Clone the repository to your local machine
2. Navigate to the project root directory (location of package.json)
3. Run the command npm install to install all dependencies
4. Setting up a discord bot application
   • Follow this guide on how to set up a new discord application and add a bot
   • Save the Bot Token, Client ID and Client Secret to a new file named .env in the project root directory

Example .env file content:

DC_BOT_TOKEN=<your bot token>
DC_BOT_CLIENT_ID=<your application client id>
DC_BOT_CLIENT_SECRET=<your application client secret>
DC_BOT_PERMISSIONS=274878131264

:rocket: How to run the bot

npm run dev

This runs the application with nodemon which automatically restarts the application when changes are made.

:link: How to invite the bot

• Option 1: Follow this guide on discordjs.guide
• Option 2: Use the base Url https://discord.com/api/oauth2/authorize and add following url parameters:
  • client_id: Your application client id (DC_BOT_CLIENT_ID)
  • permissions: All permissions the bot should have when invited as a string (274878131264)
  • scope: bot%20applications.commands

:question: What is Hacktoberfest?

A month-long celebration from October 1st - 31st sponsored by Digital Ocean and GitHub to get people involved in Open Source.

Create your very first pull request to any public repository on GitHub and contribute to the open source developer community.