Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yahu1031/flutterbot
A discord bot which helps in providing all the data about flutter objects/packages/widgets the user needs on his/her commands.
https://github.com/yahu1031/flutterbot
bot dart discord discord-bot flutter flutterfire pub
Last synced: 28 days ago
JSON representation
A discord bot which helps in providing all the data about flutter objects/packages/widgets the user needs on his/her commands.
- Host: GitHub
- URL: https://github.com/yahu1031/flutterbot
- Owner: yahu1031
- License: mit
- Created: 2020-10-08T08:21:14.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-30T22:21:30.000Z (almost 2 years ago)
- Last Synced: 2023-03-10T17:23:23.921Z (over 1 year ago)
- Topics: bot, dart, discord, discord-bot, flutter, flutterfire, pub
- Language: Dart
- Homepage:
- Size: 196 KB
- Stars: 18
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Welcome to flutter-bot 🤖
This is a [**Flutter**](https://flutter.dev) Discord bot created with the [Nyxx Library](https://nyxx.l7ssha.xyz/). 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.
* **`!\ help`**
We have a few [Flutter](https://flutter.dev/) 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`
* **`!\ help`**
We have few [pub](https://pub.dev/) 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`](https://pub.dev) API documentation.
* Eg: `!pubdocs google_fonts`
* **`!\ list`**
We have a few [Flutterfire](https://firebase.flutter.dev/) commands and they are listed below
* `!flutterfire list` - This command will give you the docs link about flutter firebase.
* Eg: `!flutterfire list`
* `!flutterfire `
* 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.
```sh
git clone https://github.com/yahu1031/FlutterBot.git
```
2) Create a `.env` file in the project root directory and paste this code given below.
```env
BOT_TOKEN=
PREFIX=!
CLIENT_ID=
```
> **Note:**
>
> 1) Prefix variable is recommended to be `!`.
>
> 2) The links in the environment variables must not be disturbed.
3) Get the dependencies.
```sh
dart pub get
```
4) Run the bot.
```sh
dart ./bin/flutter_bot.dart
```
## 👤 Author ##
**Minnu**
* Github: [@yahu1031](https://github.com/yahu1031)
* Twitter: [@minnu6931](https://twitter.com/minnu6931)
* Instagram: [@\_son_of_raghava.rao\_](https://instagram.com/_son_of_raghava.rao_/)
## 🤝 Contributing ##
Contributions, Issues, and feature requests are welcome!
Feel free to check [issues page](https://github.com/yahu1031/FlutterBot/issues). You can also take a look at the [contributing guide](https://github.com/yahu1031/FlutterBot/blob/main/CONTRIBUTING.md). Please don't forget to check [Code of Conduct](https://github.com/yahu1031/FlutterBot/blob/main/CODE_OF_CONDUCT.md).
## 💪 Show your support ##
Give one ⭐️ if this project helped you!
## 📝 License ##
Copyright © 2020 [minnu](https://github.com/yahu1031).
This project is [MIT](https://github.com/yahu1031/FlutterBot/blob/main/LICENSE) licensed.
## New Changes ➕ ##
***Major changes***
> NOTHING MUCH
***Minor Changes***
Added version command
## Hidden Commands ##
Three commands have been hidden from the commands available.
* `!ask `
* `!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. [🤖](https://discord.com/api/oauth2/authorize?client_id=756127435065655336&permissions=8&scope=bot)
**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](https://discordapi.com/permissions.html) 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