GithubHelp home page GithubHelp logo

study-bot's Introduction

Study Bot

Study Bot is a Discord bot that will help students find partners to study with. Students will be able to find other students looking for people to work with, then have a Discord channel created for them to work together.

Setup instructions

1. Create the Discord bot

First, we'll need to create a Discord bot and get a token for it. For this, we can follow the Discord.js guide found here.

2. Invite the bot to your server

Next, we'll need to invite the bot to our server. For this, we can follow the guide on the Discord.js website found here

3. Set up the config.json file

Next, we'll need to set up the config.json file. In the terminal, run the following commands:

cp example.config.json config.json

This created a copy of the example.config.json file. Now, we can open config.json in VS Code and replace the fields there with our values.

{
    "token": "",
    "clientId": "",
    "guildId": ""
}

There are three fields in the config.json file.

  • The token field is the token from the Discord bot.
  • The clientId field is the client ID from the Discord bot. This can be found by right-clicking on the bot, and clicking "Copy ID".
  • The guildId field is the ID of the server that the bot is in. This can be found by right-clicking on the server, and clicking "Copy ID".

4. Run the bot

Now, we can run the bot. In the terminal, run the following command:

npm install

This will install all of the dependencies for the bot. Next, we'll need to deploy the slash commands to the server. In the terminal, run the following:

node deploy-commands.js

Now, we can run the bot:

node index.js

5. Stuff to try

Ping command

Try the ping tommand to make sure it works. Then, change the ping command to instead reply "Hello world!".

Learn some more advanced command creation techniques

Read the docs here and try some things out.

study-bot's People

Contributors

angelonfira avatar johnlu2004 avatar mathyoumb 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.