Skip to content

yahu1031/FlutterBot

Repository files navigation

Welcome to flutter-bot πŸ€–

Version Documentation Maintenance License: MIT

This is a Flutter Discord bot created with the Nyxx Library. This bot provides useful resources like docs, pub plugins/packages and API docs, flutterfire docs.

Usage

Commands and Examples

  • @Bot Name

    On mentioning the bot will give you the usage of commands embed message.

  • !\<Flutter Command\> help

    We have a few Flutter commands and they are listed below

    • !topwidget - This command will show the top Package/Object you are searching for.

      • Eg: !topwidget hero

    • !allwidgets - This command will show you all Packages/Objects related to your search.

      • Eg: !allwidgets hero

    • !prop - This will help you with the property you are searching for a particular widget.

      • Eg: !prop hero.tag

    • !allprop - This command will show all the properties of a Package/Object you are searching for.

      • Eg: !allprop hero

  • !\<Pub Command\> help

    We have few pub commands and they are listed below

    • !pub - This command will give you the top search of the packages if the given command matches with the package.

      • Eg: !pub google_fonts

    • !allpub - This command will show the top 10 Packages results you are searching for.

      • Eg: !allpub google_fonts

    We also have the Pubdocs command that which provides you the Pub package's/plugin's API documentation.

    • Eg: !pubdocs google_fonts

  • !\<Flutterfire Command\> list

    We have a few Flutterfire commands and they are listed below

    • !flutterfire list - This command will give you the docs link about flutter firebase.

      • Eg: !flutterfire list

    • !flutterfire <your required docs>

      • docs
      • analytics
      • auth
      • firestore
      • functions
      • messaging
      • storage
      • core
      • crashlytics
      • database
      • remote-config
      • performance
  • There are some other commands you can explaore by using @Bot Name support

Running the Bot

  1. Clone the repository.

    git clone https://github.com/yahu1031/FlutterBot.git
  2. Create a .env file in the project root directory and paste this code given below.

    BOT_TOKEN=<your bot token>
    
    PREFIX=!
    
    CLIENT_ID=<ID of the bot OAuth2 client>

    Note:

    1. Prefix variable is recommended to be !.

    2. The links in the environment variables must not be disturbed.

  3. Get the dependencies.

    dart pub get
  4. Run the bot.

    dart ./bin/flutter_bot.dart

πŸ‘€ Author

Minnu

🀝 Contributing

Contributions, Issues, and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide. Please don't forget to check Code of Conduct.

πŸ’ͺ Show your support

Give one ⭐️ if this project helped you!

πŸ“ License

Copyright Β© 2020 minnu.
This project is MIT licensed.

New Changes βž•

Major changes

NOTHING MUCH

Minor Changes

Added version command

Hidden Commands

Three commands have been hidden from the commands available.

  • !ask <USER_ID>
  • !code

Fixes

  • Modified Java JRE and JDK links that are not currently working(22-05-2021).

Add this bot to your guild

Click on the bot to add this to your guild. πŸ€–

NOTE: By default this bot has Administrator rights. Please do change the rights as you wish after adding it to your guild or use this Permissions Calculator to calculate permissions and add your bot ID to generate an invite link.

What's-up on the next update

  • Error command to get a solution for the common errors during flutter installation.

Made with πŸ’š, From Minnu.


All assets used in this project related to flutter are taken directly from Flutter.dev

About

A discord bot which helps in providing all the data about flutter objects/packages/widgets the user needs on his/her commands.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published