Theia is a web application built with Next.js 13 that serves as an extension to the Hiperion-Bot, enabling additional functionalities and a user-friendly dashboard for managing WhatsApp groups. The application facilitates group administration, including banning participants, updating group names and photos, and adjusting bot settings within the groups. It also provides a dashboard with insights into group administrators, the bot's active groups, and a graph displaying command usage per group. The chart utilizes Recharts, a charting library for React.
To use Theia, ensure you have the following prerequisites installed:
- Node.js 18 or higher
- Running instance of Hiperion-Bot
-
Clone this repository to your local environment.
-
Install the required dependencies using Yarn:
yarn install
-
Set the
API_HOST_URLenvironment variable. -
Run the Hiperion-Bot as described in its README.md.
-
Start the Theia application using the following command:
yarn dev
The Theia application has the following main dependencies:
- Next.js 13
- Tailwind CSS
- React Hook Form
- Shadcn (Re-usable components built using Radix UI and Tailwind CSS)
- Recharts
The Theia application extends the capabilities of the Hiperion-Bot with the following features:
- Ban one or multiple participants from a group
- Update group name and photo
- Adjust bot settings within groups
- Dashboard displaying:
- Group administrators
- Active groups with the bot
- Graph showing command usage per group
We welcome contributions to improve and enhance Theia. To contribute, please follow these steps:
- Fork this repository.
- Create a branch for your contribution:
git checkout -b your-branch. - Implement the desired changes and include relevant documentation.
- Commit your changes:
git commit -m "Your message". - Push your changes:
git push origin your-branch. - Open a pull request in this repository.
We appreciate your contributions in advance!
The Theia application is licensed under the Apache 2.0 License. For more details, please see the LICENSE file.
Thank you for using Theia, the WhatsApp Bot Extension for Hiperion-Bot! If you encounter any issues or have questions, please feel free to reach out.