discord-bot by dyte

A Discord bot for Dyte's community Discord server.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contributors

About The Project

A multi-purpose Discord bot for Dyte's Discord Community.

Built With

• discord.js
• Typescript

Getting Started

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

Prerequisites

For running this bot, you would need to make create an application on Discord's developer portal, and create a bot in the application. Once this is done, you will receive the bot token, which you can use to run this project. You need to add your newly created bot to the Discord server you are going to use for testing.

Other prerequisites include:

• npm

Installation

1. Clone the repo

git clone [email protected]:dyte-in/discord-bot.git

2. Install NPM packages

npm install

3. Create a .env from the sample .env.example and update the values

cp .env.example .env

4. Run the bot in developer mode using

npm run dev

Usage

This bot can be used on Dyte's Discord Community. For example, you can head to the #bot-spam channel and run /dyte or $dyte to create a new Dyte meeting.

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 'feat: Add some AmazingFeature')
4. Push to the Branch (git push -u origin feature/AmazingFeature)
5. Open a Pull Request

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project 😄.

License

Distributed under the MIT License. See LICENSE for more information.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Rohan Mukherjee 💻 📖 🚇

Rishit Bansal 💻 📖 🚇

This project follows the all-contributors specification. Contributions of any kind welcome!