god-father-xuez / switchblade

The open source Discord bot that solves all of your problems.

Multi purpose Discord Bot made using discord.js, focused on quality, organization and enjoyability.

Vote on DBL

The open source Discord bot

Switchblade is a free and open source solution to all of your server managing problems, built from scratch with code organization and quality in mind. Want some music for your server? We've got you covered. Maybe you want a good anti-spam solution? We've got you covered. How about economy? Well, you probably got it by now. Like the idea? Click here to invite Switchblade to your server.

Contributing

You want to help? Great! There are many ways to do it:

Contribute with code: Setup a development environment, make some changes, and open a pull request.

Contribute with ideas: Have a great idea, but don't know how to code (or maybe you're just too lazy to do it)? No problem! Open an issue so we can talk about your awesome idea.

Contribute by hunting bugs: Just like Discord, we have an awesome team of bug hunters. You can join our server and ask for the Bug Hunter™ role. After that, you can start hunting bugs and reporting them.

Contribute with translations: Switchblade's translation is Crowdsourced too! Click here to learn more.

Branching

New Pull Requests should be made upon the dev branch, where Switchblade Canary, our private testing instance, runs. Every two weeks, we push code from dev to master, where the production instance runs.

Setting up a development environment

For this guide, we're assuming that you already have NPM, Node and Windows Build Tools installed.

0. Fork the repository (You don't have to do this if you're part of our organization)

1. Clone your fork and checkout the dev branch

git clone https://github.com/<your username>/switchblade
cd switchblade
git checkout dev

2. Install all the dependencies with NPM

npm install

3. Create a file named .env inside of the bot's folder and add all of the required environment variables to it.

In the end, your file should look like this:

DISCORD_TOKEN=NDQ0OTU4ODkyMzgwNzgyNTky.Dhxlog.2VyI9uaXRO0t36vMsH5wVDjqpfk
PREFIX=s!

4. Run the bot!

npm run start-dev

The start-dev script loads the variables from .env into the process, and automatically restarts the bot when you make changes to the code.

Happy hacking!