A multipurpose bot to assist you with code, moderation and more, while integrating more features in it.
Go to any channel in discord of any server where this bot is invited, and
invoke it using =help
.
If you're interested in growing this project further, Add a .env file based on .env.example file. And add the following things:
This guide is to assist you with self-hosting and running an instance of this bot for yourself.
Docker is an easy way of containerizing and delivering your applications quickly and easily, in an
convenient way. It's really simple to get started with this, with docker handling all the installation
and other tasks.Configure the environmental variables by renaming the .env.example
file to .env
with the respective
values. Then, run docker-compose --env-file .env up
after getting the project and config ready.
Docker mini guide:
docker-compose --env-file .env up
docker-compose down
docker-compose build
This is a clean and neat way of hosting without using docker. You can follow this if docker doesn't work well on your system, or it doesn't support it. Containers are resource intensive, and your PC might not be able to do it, this is the perfect method to get started with the self-hosting.
You need a postgres database configured locally to run this bot. If you haven't done that yet, take a look at the official documentation from EDB (The company behind postgres) here
Once your done, create the databases and users accordingly, and configure it in .env
as said in the future steps.
pipenv
, a virtual env for python. Command: pip install pipenv
pipenv update
.env.example
file to .env
with the respective
values for it. If you're using heroku or other platforms that have option for external environmental
variables, use that instead of .env
config.py
inside the Bot module, according to your
preferences.pipenv run start
We support database changes and migrations for the latest structures instead of dropping and recreating
them. We use alembic
, a sqlalchemy tool to perform the migrations for us.
Migration guide:
alembic revision --autogenerate
alembic upgrade head
NOTE: If you're using pipenv, go into the shell first using pipenv shell
to use those commands.
Contributions, issues and feature requests are welcome. After cloning & setting up project locally, you can just submit a PR to this repo and it will be deployed once it's accepted. The contributing file can be found here.
⚠️ It’s good to have descriptive commit messages, or PR titles so that other contributors can understand about your commit or the PR Created. Read conventional commits before making the commit message.
We love people's support in growing and improving. Be sure to leave a ⭐️ if you like the project and also be sure to contribute, if you're interested!