Quick start guide

Quick start guide

This guide will help you to quickly start developing neW features for the bot.

Prerequisites

• Node.js (v17 or higher)
• TypeScript (v4.4 or higher) Wich is included in the dev-dependencies of node
• Git
• MongoDB (v4.4 or higher)

• Discord Bot Token, you can get one here
• Discord Bot Client ID, you can get one here
• Discord Bot Client Secret, you can get one here

Setup

First, clone the repository:

git clone https://github.com/fernandomema/zumito.git

Then, install the dependencies:

npm install

Copy the .env.example file to .env and fill the variables with your data.

Bash

cp .env.example .env

Powershell

Copy-Item .env.example -Destination .env

cmd

copy .env.example .env

You can find more information about the .env file here.

Development

Once the project is configured, you can add or modify the different modules of the bot following the documentation of the framework.

Execute

To execute the bot, run:

npm run start