Skip to content

Nickelza/one-piece-group-bot-dashboard

Repository files navigation

one-piece-group-bot-dashboard

LOC License Project Status

Official Links

Quick Links


Overview

Dashboard for the One Piece Group Bot, written in Python using the Streamlit framework.


Features

  • Search players
  • Send players to Impel Down
  • Create and award Devil Fruits
  • Appoint Warlords

Getting Started

Requirements

Having configured the One Piece Group Bot

  • Create another Telegram Bot using the BotFather called TG Rest Bot and obtain the bot token
  • Create a channel for communication with the One Piece Group Bot called TG Rest Channel
  • Set the environment variable TG_REST_CHANNEL_ID of One Piece Group Bot to the TG Rest Channel ID

Installation

  1. Clone the one-piece-group-bot-dashboard repository:
git clone https://github.com/Nickelza/one-piece-group-bot-dashboard
  1. Change to the project directory:
cd one-piece-group-bot-dashboard
  1. Install the dependencies:
pip install -r requirements.txt
  1. Create a secrets.toml file under .streamlit folder set the required environment variables as described in the .streamlit/secrets.toml.example file.
  • OP_GROUP_BOT_ID - Bot ID of the One Piece Group Bot
  • TG_REST_BOT_TOKEN - Telegram Bot Token for the TG Rest Bot
  • TG_REST_CHANNEL_ID - Telegram Chat for communication with the One Piece Group Bot

Database information must be the same used for One Piece Group Bot

  • DB_NAME - MySQL Database Name
  • DB_HOST - MySQL Database Host
  • DB_PORT - MySQL Database Port
  • DB_USER - MySQL Database User
  • DB_PASSWORD - MySQL Database Password

For a full list of environment variables and their descriptions, refer to the resources/Environment.py file.

Running one-piece-group-bot-dashboard

Use the following command to run one-piece-group-bot-dashboard:

streamlit run main.py

To deploy online, refer to the Streamlit documentation.


Project Roadmap


Contributing

Contributions are welcome! Here are several ways you can contribute:


License

This project is protected under the GNU GPLv3 License. For more details, refer to the LICENSE file.


Return


About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages