Discord Server | Deploy CI | Docker CI | pre-commit | Style |
---|---|---|---|---|
OwO, What's this?
Peradaban is a Discord Server Bots made with NAFF (python) designed only for Warung International.
Visit the official guide to get started.
This project is open to anyone who wants to contribute, large or small! Whether you noticed a typo or want to add a whole new feature, go for it!
Large additions should be discussed in issues or on Discord first. If you're new to Python, ask me on Discord for where to start and you can use Peradaban as a starting point for a contribution.
Also, Please note that this code is Production Ready. It means, this code is a live source code of our discord server bot.
To run the app, you need:
- A Discord server to test - you can't use the Warung International Discord Server to do tests
- Python 3.11.1 - no guarantees on older versions
- A Discord bot with the 'Message Intent', 'Server Members Intent', and 'Presence Intent' enabled
- MongoDB Server, or MongoDB Atlas.
If you don't own/admin a Discord server, creating one is simple, you can do it from the same menu you join discord servers from.
There are multiple ways to launch the application.
To start the bot with python, you first need to install the required packages with pip install -r requirements.txt
Then, run:
python main.py
You can use the pre-made Docker Compose by running:
docker-compose up
For most users, the use of docker-compose
is highly recommended.
Nevertheless, you can import the pre-made Dockerfile into your own docker-compose or run it manually by with:
docker build -t peradaban .
docker run -it peradaban
Note: Make sure that you created a volume so that you local ./logs
folder gets populated.
Additionally, this comes with a pre-made pre-commit config to keep your code clean.
It is recommended that you set this up by running:
pip install pre-commit
pre-commit install
Awesome projects that i take reference from, credits to all of them :3