Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 1.87 KB

README.md

File metadata and controls

65 lines (40 loc) · 1.87 KB
Raw

CodeAlert

A Discord bot that retrieves a list of coding contests from an API and displays them in Discord channels using slash commands.

Video Demo

If you're interested, please check out the Code Alert Alexa Skill, with which you can access the same functionality from your Alexa device.

Usage

To use the bot, invite it to your Discord server using this link:

The bot supports the following slash commands:

/mondaytosunday

Lists all contests in the current week (Monday to Sunday).

/24h

Lists all the contests within 24 hours.

/7days

Lists all the contests within this week.

Installation

Prerequisites

To host and run the bot yourself, you'll need the following:

  • Node.js
  • A Discord account
  • A Discord bot and its token. Follow the Discord.js guide to learn how to create a bot and obtain its token.

To host the bot yourself, follow these steps:

  1. Download the latest release of the bot from the GitHub repository.

  2. Extract the contents of the release archive to a directory on your machine.

  3. Create a config.json file in the root directory of the project and replace YOUR_TOKEN with your Discord bot token and BOT_ID with your Discord bot's client ID:

{
	"token": "YOUR_TOKEN",
	"clientId": "BOT_ID"
}
  1. Install the required dependencies.
npm install
  1. Start the bot.
node index.js

License

This project is licensed under the MIT License - see the LICENSE file for details.