/zumito-framework

Primary LanguageTypeScript

Contributors Forks Stargazers Issues MIT License


Logo

Zumito framework

Fast and scalable discord bot framework to jumpstart your projects!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

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 and start building your bot today!

(back to top)

Built With

This section lists the major frameworks and libraries that the framework is built with.

(back to top)

Getting Started

This is a guide of how you can set up the project locally to start contributing to the framework.

⚠️ If you're here to create your own bot, refer to the quickstart guide at docs.zumito.ga/docs/custom/quickstart.

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 
    git clone https://github.com/ZumitoTeam/zumito-framework.git
  2. cd into the project directory 
    cd zumito-framework
  3. Install NPM packages 
    npm install

(back to top)

Usage

For build the source code, run the following command:

npm run build

Then for test it, you will need to create a bot, you can find a guide here.

for link the framework to your bot, you will need to run these commands

  1. In the root of framework:

    npm link

  2. Then in the root of your bot:

    npm link zumito-framework

For more info of the framework, please refer to the Documentation

(back to top)

Roadmap

  • Add Quick start template
  • Add more documentation, examples, and guides
  • Add cli for easy command, events, etc boilerplate generation.

See the open issues for a full list of proposed features (and known issues).

(back to top)

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Support

Any questions or suggestions? Come to our Discord server and chat with us!

(back to top)

Acknowledgments

We would like to thank the following projects for their inspiration and/or help:

(back to top)