Saurita

A discord bot to manage our things like:

• Remember events:
  • Meetings
  • Birthdays
  • Deadlines
• Welcome new people
• React to some text messages
• Provide regular feedback on the status of our projects and statistics
• Play music

How it works

The bot is built using the discord.js library. It uses the slash commands feature to interact with users.

The diagram is the following:

Requirements

• Node.js (>=v16.11.0).

• Download .env file and place it in the root directory of the project.

Installation

npm install

Run the bot

npm start

Format the code

npm run format

Check linting

npm run check-format

Run tests

npm run test

Deployment

Only in our Discord server

npm run deploy-commands-guild

Globally

npm run deploy-commands-global

Development

Add a new command

1. Create a new file in the commands directory.
2. You must export a function with the following signature:

module.exports = {
    data: new SlashCommandBuilder()
        .setName("new-command")
        .setDescription("New command description"),,
    execute: async (interaction) => {
        // Your code here
    }
};

3. Add a mock test in the tests directory.

Add a new event

1. Create a new file in the events directory.
2. You must export a function with the following signature:

module.exports = {
    name: 'event-name',
    execute: async (interaction) => {
        // Your code here
    }
};