IEEE CS Discord Bot

A discord bot for managing our discord server.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing

About The Project

Discord bot for IEEE SB MUJ Discord server.

Built With

• Discord.js
• Firebase
• Google Sheets API

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

• Setup firebase firestore - https://firebase.google.com/ and save the config file at the root as firebaseServiceAccount.json
• Setup a google cloud platform app and enable the google sheets api and save the credentials at the root of the project as googleApiCredentials.json (Follow this tutorial)

Installation

1. Clone the repo

   git clone https://github.com/ieeemuj/acceletatorBot.git

2. Move inside the folder

   cd acceleratorBot

3. Install NPM packages

   npm install

Usage

Session Commands

• ./start or ./s Starts the session and will display a embed message

• ./attendance or ./a Collects the names of the attendees in the mentor's voice channel and sends the list to the mentor as a direct message.

  

  The mentor will receive a DM-

  

  The attendance will be updated in the google sheet associated with the bot.

Configuration

• ./setprefix new prefix Use to change the prefix for which the bot responds, default is ./

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

• Manavendra Sen
• Divyanshu Sharma

PRs are welcome 🚀