StatsBot - A Discord Bot to gather data from public APIs

Note
This project does participate in the Hacktoberfest 2022 event!

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

✨ How to contribute

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

No open issues at the moment? Feel free to create one and ask to be assigned to it!

✅ Available commands

Command	Description	API
`/invitelink`	Shows the invite link for the bot
`/ping`	Pong!
`/serverinfo`	Shows information about the server
`/userinfo`	Shows information about the user
`/excuse`	Sends a random excuse	Excuser
`/show-chess-leaderboard`	Shows information about the current chess.com leaderboard	chess.com
`/trivia`	Fetches a random question with answer as true and false	opentdb.com
`/numberfact`	Shows a random number fact	numbersapi.com
`/catfact`	Shows a random fact about cats.	meowfacts

🔧 Installation

Prerequisites

Node.js (v16.6.0 or higher)
Discord Account

Project Setup

Fork or Clone the repository to your local machine
Navigate to the project root directory (location of package.json)
Run the command npm install to install all dependencies
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

🚀 How to run the bot

npm run serve

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

🔗 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

❓ 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.

Madhvik007 / statsbot