Giter VIP home page Giter VIP logo

iitp-discord-bot's Introduction

IIT Patna Discord Bot

A discord bot for IIT Patna community on any discord server.

Essentials

Installing

NOTE make sure that you have node js installed in your system. If not follow the these installation instructions https://discordjs.guide/preparations/

  1. Fork the repository, clone the forked repo and switch to its directory - git clone https://github.com/<your github username>/iitp-discord-bot.git && cd iitp-discord-bot
  2. Install npm packages - npm install
  3. Put the bot token in configs/config.json. For security purpose the bot token is not put in the file. Contact @piyushchauhan to get the bot token.
  4. Download the google-sheets.json key in configs/ folder and make sure that keyFile:'configs/google-sheets.json' is set in services/googleSheetsService.js
  5. Run the node server by running node .

Now the bot is up and running

How to test the bot?

  • Go to the test server.
  • Make sure the bot is online and the node server is running.
  • Send the message(!ping) in the #testing channel of the test discord server. the bot will pick the message and accordingly do actions based on the code.

How to contribute?

  1. Join the discord server mentioned above.
  2. Follow the installation instructions above.
  3. If you face any diffuculty feel free to send a message on general channel of the discord server.
  4. After installation, and successfull testing, you can look into the issues that interest you and add a comment on that issue saying that you want to work on it.
  5. If you are confirmed to work on the issue, you can for start working on it. Finally after the issue/feature requirements are complete then you can create a PR targeting dev branc. Mentioning the changes you made and the issue you are solving in the PR.
  6. Your PR will be reviewed. If the changes made are appropriate then it will be merged in the dev branch.

Tutorials

iitp-discord-bot's People

Contributors

piyushchauhan avatar dhushyanth-s avatar kagrawal61 avatar tejas1510 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.