Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zumitoteam/zumito-framework
Framework for creating a bot for discord
https://github.com/zumitoteam/zumito-framework
bot bot-framework discord discord-bot discord-js discord-js-framework framework nodejs typescript
Last synced: about 1 month ago
JSON representation
Framework for creating a bot for discord
- Host: GitHub
- URL: https://github.com/zumitoteam/zumito-framework
- Owner: ZumitoTeam
- Created: 2022-10-31T16:27:42.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-21T10:08:34.000Z (about 2 months ago)
- Last Synced: 2024-09-24T12:02:56.592Z (about 2 months ago)
- Topics: bot, bot-framework, discord, discord-bot, discord-js, discord-js-framework, framework, nodejs, typescript
- Language: TypeScript
- Homepage: https://framework.zumito.dev
- Size: 486 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
Zumito framework
Fast and scalable discord bot framework to jumpstart your projects!
Explore the docs »
View Demo (Coming soon)
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
Introducing the ultimate framework for building high-quality Discord bots quickly and efficiently. Say goodbye to the tedious task of building a bot from scratch and focus on creating something truly amazing. This framework is designed to implement DRY (Don't Repeat Yourself) principles (like command handler, event handler, etc), allowing you to spend more time creating and less time doing repetitive tasks.
With this framework, you can easily create a feature-rich bot that solves a problem and helps others. Whether you're an experienced developer or just getting started, this framework is perfect for anyone looking to build a bot with minimal effort and maximum results.
The framework is constantly evolving, with new features and updates being added on a regular basis. You can also suggest changes and contribute to the development of the framework by forking the repo and creating a pull request or opening an issue. Thanks to all the contributors who have helped expand this framework!
To get started, simply visit the quickstart guide at [docs.zumito.ga/docs/custom/quickstart](https://docs.zumito.dev/guides/start/) and start building your bot today!
### Built With
This section lists the major frameworks and libraries that the framework is built with.
* [Node.js](https://nodejs.org/en/)
* [TypeScript](https://www.typescriptlang.org/)
* [Discord.js](https://discord.js.org/#/)
* [Express](https://expressjs.com/)
## Getting Started
This is a guide of how you can set up the project locally to start contributing to the framework.
:warning: If you're here to create your own bot, refer to the quickstart guide at [docs.zumito.dev/guides/start](https://docs.zumito.dev/guides/start/).
### Prerequisites
This is a list of things you need in order to set up the project locally.
* node 17.0^ and npm
### Installation
To set up the project locally, follow these steps:
1. Clone the repo
```sh
git clone https://github.com/ZumitoTeam/zumito-framework.git
```
2. cd into the project directory
```sh
cd zumito-framework
```
3. Install NPM packages
```sh
npm install
```
## Usage
For build the source code, run the following command:
```sh
npm run build
```
Then for test it, you will need to create a bot, you can find a guide [here](https://docs.zumito.dev/guides/start).
for link the framework to your bot, you will need to run these commands
1. In the root of framework:
```sh
npm link
```
2. Then in the root of your bot:
```sh
npm link zumito-framework
```
## Roadmap
| Title | Status | Assignee | Body |
| :------------------------------------------------------------------------------------------------------------------------------------ | :---------------------: | :------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Implement scheduled task system | :eight_spoked_asterisk: | | We need to implement a system that allows scheduling and automatically executing tasks at specific times or at regular intervals. |
| [💡] Implement Dashboard for Application Monitoring and Control | :eight_spoked_asterisk: | | **Problem Description:**
Currently, we lack a centralized system to visualize and manage the state of our application. We propose creating a dashboard that provides an intuitive web interface to monitor the bot's status, execute commands remotely, and provide detailed information about activity on the servers. This dashboard should also be scalable to add new functionalities in categories such as status, configuration, and administration options.
... |
See the [open issues](https://github.com/ZumitoTeam/zumito-framework/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Support
Any questions or suggestions? Come to our [Discord server](https://discord.gg/rFywZxgsyF) and chat with us!
## Acknowledgments
We would like to thank the following projects for their inspiration and/or help:
* [Discord.js](https://discord.js.org)
* [Caminte](https://github.com/biggora/caminte)
[contributors-shield]: https://img.shields.io/github/contributors/ZumitoTeam/zumito-framework.svg?style=for-the-badge
[contributors-url]: https://github.com/ZumitoTeam/zumito-framework/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/ZumitoTeam/zumito-framework.svg?style=for-the-badge
[forks-url]: https://github.com/ZumitoTeam/zumito-framework/network/members
[stars-shield]: https://img.shields.io/github/stars/ZumitoTeam/zumito-framework.svg?style=for-the-badge
[stars-url]: https://github.com/ZumitoTeam/zumito-framework/stargazers
[issues-shield]: https://img.shields.io/github/issues/ZumitoTeam/zumito-framework.svg?style=for-the-badge
[issues-url]: https://github.com/ZumitoTeam/zumito-framework/issues
[license-shield]: https://img.shields.io/github/license/ZumitoTeam/zumito-framework.svg?style=for-the-badge
[license-url]: https://github.com/ZumitoTeam/zumito-framework/blob/master/LICENSE.txt