mateuszucco / roster-bot

This is Roster Bot, created in my undergraduate thesis for IFRS that I created a Telegram chatbot with the purpose of helping users when they need manage a roster.

Roster Bot API

This is a Telegram Chatbot, called Roster Bot, with the purpose of helping users when they need manage a roster. I did it for my undergraduate thesis for IFRS about Chatbots. You can find the bot in Telegram here.

About this project

In this repository you will find a Telegram ChatBotbuilt with Node.js, JavaScript, Telegraf.js and Axios, with the main objective of assisting users in organizing rosters, using the Roster-Bot-Api to service rosters and manage route items, in addition to registering users through the Roster-Bot-Website.

ChatBot functions

• Authenticate user
  
  
  
  
• Show all rosters
  
  
  
  
• Create new roster
  
  
  
  
• Edit roster
  • edit title
    
    
    
    
  • Edit description
    
    
  • Remove item
    
    
    
    
  • Add new item
    
    
  • Edit item
    
    
• Delete roster
  
  
  
  

Getting Started

Prerequisites

To run this BOT in the development mode, you'll need to have a environment with NodeJS installed and run the API.

Environment variables example

Create a .env.token file to save yours environment variables, like this:

const TOKEN = "your token bot"
module.exports = {
    TOKEN
}

Installing

Cloning the Repository

$ git clone https://github.com/MateusZucco/Roster-Bot.git
$ cd roster-bot

Installing dependencies

$ npm install

Running the Development environment

With all dependencies installed, the Database running and the environment properly configured, you can now run the server:

$ npm run dev