Coder Social home page Coder Social logo

warung-international / peradaban Goto Github PK

View Code? Open in Web Editor NEW
1.0 0.0 0.0 11.53 MB

Proprietary bot for the Discord server of the Warung International.

License: MIT License

Shell 0.48% Dockerfile 0.37% Procfile 0.01% Python 99.13%
dis-snek discord-bot python naff

peradaban's Introduction

Discord Server Deploy CI Docker CI pre-commit Style
Discord server Deploy to Fly.io Build Production precommit Code style: black

Peradaban

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.

Development

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.

Testing/Workflow

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.

Running the Application

There are multiple ways to launch the application.

Python

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

Docker-Compose

You can use the pre-made Docker Compose by running:

docker-compose up

Docker

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.

Additional Information

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

Awesome projects that i take reference from, credits to all of them :3

peradaban's People

Contributors

dependabot[bot] avatar gnztmpz avatar pre-commit-ci[bot] avatar sanityzeropercent avatar

Stargazers

 avatar

peradaban's Issues

crediting others

Hey mate, it would be really nice if you credited people if you use their code. Like for example me when using a good chunk from my bot, or others as well.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.