Welcome to flutter-bot 🤖

This is a Flutter Discord bot created with Discord.js. 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

Running the Bot

Clone the repository.

git clone https://github.com/yahu1031/FlutterBot.git

Create a .env file in the root folder and paste this code given below.

BOT_TOKEN=your bot token

PREFIX=!

DOCSLINK=https://api.flutter.dev/flutter/

FLUTTERAPI=https://api.flutter.dev/flutter/index.json

PUBAPI=https://pub.dev/api/search?q=

MAINTAINERID=ID of the bot maintainer

FLUTTERFIRE=https://firebase.flutter.dev/docs/

PUBAPIDOCS=https://pub.dev/documentation/

Note:

Prefix variable is recommended to be !.

The links in the environment variables must not be disturbed.

Get the dependency modules.
```
npm i
```
Run the bot.
```
npm run start
```

NOTE: If you want to follow eslint and markdownlint please do install plugins for them.

👤 Author

Minnu

Github: @yahu1031
Twitter: @minnu6931
Instagram: @_son_of_raghava.rao_

🤝 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

New Changes ➕

Major changes

Added new commands !git, !adb.
Added new help command @FlutterBot support.
Added errors survey.

Minor Changes

corrected spelling mistakes.

Hidden Commands

Three commands have been hidden from the commands available.

!ask <USER_ID>
!code

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

urahamat01 / FlutterBot