Skip to content

Latest commit

 

History

History
113 lines (74 loc) · 4.63 KB

CONTRIBUTING.md

File metadata and controls

113 lines (74 loc) · 4.63 KB

Contribute to flutter-bot 🤖

Version Documentation Maintenance License: MIT

🏠 Homepage

Steps to contribute something to this bot as follows

  1. Fork the project 🍴.
  2. Development Environment 🔨.
  3. Test server and bot account ⚡.
  4. Configure the bot 🔧.
  5. Run the project 🏃.
  6. Working with Git 👨‍💻.

Get Started

Fork the project 🍴

Fork us to your repo and help us developing more better. Create a branch in the forked repo and work on the branch. Make PR(Pull Request) on what ever you worked on. PRs are most welcome.

Development Environment 🔨

  1. Clone your forked repository.

    git clone "your repo link"

  2. Install required packages.

    dart pub get

  3. Be ready to develop it 😉.

Test server and bot account ⚡

You will be needed your own test server and bot account on Discord to test the bot with your changes.

  1. Create a Discord server.
  2. Create a Discord developer account.

Invite the FlutterBot to the server you have created. If you are not aware of adding a bot to the server, Here is the Documentation to do it.

Configure the bot 🔧

To configure the bot you must need to add some variables.

In the root dir create a file called .env and add the variables in the file.

  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.

Run the project 🏃

You are almost done with the setup and start running the bot

dart ./bin/flutter_bot.dart

If your output in the console seems like this

SUCCESS [Tue, 9/6/2022 3:01:30 AM] - Flutter Bot#1358 is ready to go 🔥

then, Congrats you made it.

Working with Git 👨‍💻

  1. We are on the final step now 😆. After developing the code you can make a PR. All PRs are welcome.
  2. If any issues were found please make use a note by raising issues.

Show your support

Give one ⭐️ if this project helped you!

Fork this repository and develop.

📝 License

Copyright © 2020 minnu.
This project is MIT licensed.

Made with 💚, From Minnu.


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