MelvinJS - a multipurpose discord bot, (re)written in JS

Melvin

A multipurpose Discord bot
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

A multipurpose discord bot. More to come later!

Built With

• Discord.js
• discord-music-player
• Crayola™ Crayons

Getting Started

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

Prerequisites

• A computer
• Internet connection
• Discord Account
• Docker or Podman

Installation

1. Clone the repo

   git clone https://github.com/eRgo35/MelvinJS.git

2. Install docker (or podman) on your system

3. Create an .env file using the provided template

   cp .env.template .env

4. Set all necessary api keys

   vim .env

5. Create and run the container using the provided Dockerfile

   docker run -it .

6. (OPTIONAL) Use docker compose

   docker compose up -d

Usage

• Music
• Metar
• Network Tools
• QR Code Generation
• More Soon™

For more examples, please refer to the Documentation

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 newFeature)
3. Commit your Changes (git commit -m 'Add a new and exciting Feature!')
4. Push to the Branch (git push origin newFeature)
5. Open a Pull Request

License

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

Contributors ✨

Thanks goes to these wonderful people (emoji key):

dawidokox1 💻

Michał Czyż 💻

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