this-iz-ayush / saturn-bot Goto Github PK

Saturn is a full-modular multipurpose, user and developer-friendly discord bot. Just perfect for manage your server and provide the best experience for you and your community. All of that and more, together on the most fantastic planet in our solar system!

Saturn is a self-hosted bot, this means you will need to host and maintain your own instance. For that, you can instantiate at your own machine or you can use a cloud platform to do that. A great cloud platform that I have used before and recommend is Heroku, it's a nice cloud service that offers great compatibility for apps like this one, and also has a free plan option.

Please notice, that you're NOT allowed to upload this bot to any service such as "discordbotlist" or "top.gg". You're only allowed to host this bot for your community.

In this step-by-step, I will only cover how you can set Saturn in your own machine. Also, notice that each topic in the next sections has a brief description in the title explaining what we're about to do. With that being said, let's move on.

First things first, make sure that you have git, node, and npm installed. Then open your terminal or cmd and type the commands below.

git clone https://github.com/larafe1/saturn-bot.git

cd saturn-bot

-- Using npm:
npm install

-- Using yarn:
yarn

When the installation finishes, find the .env.example inside of the project's folder and open it with some text editor of your choice.

Now, make sure that you have your bot token and app id in hands — in case you don't know how to get these things, go to the Discord developers portal and create a new app, copy your application id and then, go to the "Bot" section and copy your generated token.

After that, set your credentials, and also, your GUILD_ID. When you're done, rename the .env.example to .env.

BOT_TOKEN=
BOT_APP_ID=
GUILD_ID=

Saturn also provides integration with Prisma, which is an ORM, and already has a built-in error database, which is a database that stores all the errors that the bot has encountered during its runtime. This can be useful for debugging purposes. To have this feature enabled, you must set the DATABASE_URL environment variable to the URL of your database, which is also available in the .env.example file.

DATABASE_URL=

-- Using npm:
npm run dev

-- Using yarn:
yarn dev

That's pretty much it, thanks for using Saturn and have fun!

Also, in case you wanna contribute to this project, PRs are more than welcome, feel free to open one.

This project is licensed under a GNU General Public License v3.0 License