‼️ TO-DO list after creating repo from template:
- Create new flutter project
- Organizing a library package
- Replace all
project_name
with the corrent one in this file - Replace
repo name
with the corrent one in:- this filein the
- contributing
create an issue
link
- Remove useless parts of this README
- Check license
- Specifying a plugin’s supported platforms. More here
- Uncomment CI scripts in
.github/workflows
- Set the latest
Flutter version
inside all of them
- Set the latest
- Setup
repository settings
- branch rules, PR reviews, etc. Sadly, but it's not copied from the template repo... - to enable
codeCov
- please ask Felix to enable it for this repository - Try to keep README page SIMPLE but USEFUL
- Chgeck for PUB POINTS
- Follow Dart file conventions(https://pub.dev/help/scoring#follow-dart-file-conventions) (this one done, but doubel-check it)
- Provide documentation
- Support multiple platforms
- Pass static analysis
- Support up-to-date dependencies
- View pub points report before publishing. Make sure we have all possible score 💪
- Remove this
TODO list
from the ReadMe, when all above are done 😉
project_name
Short description of the project: What, Why, When and How 🤣
Table of content:
Installing 🛠️
Add this to your package's pubspec.yaml
file:
dependencies:
project_name: `latest version`
after that, shoot it on the command line:
$ flutter pub get
How to use 🏗️
Use case #1 (short description)
// add some code with ninja-comments here
Use case #2 (short description)
// add some code with ninja-comments here
Use case #3 (short description)
// add some code with ninja-comments here
- please also give a try to the example app 😜
- check full documentation here
Visuals 😻
Curious how it will be looking? 😏
case description #1 | case description #2 |
![]() |
![]() |
case description #3 | case description #4 |
![]() |
![]() |
Attributes ⚙️
attribute name | Datatype | Default Value | Description |
---|---|---|---|
child |
Widget |
required |
The widget below this widget in the tree. |
isEnabled |
bool |
true |
Responsible for showing component as enabled. |
key |
Key |
null |
Controls how one widget replaces another widget in the tree. |
Troubleshooting 🤔
Describe here well known problems and how they can be solved.
Contributing 👷♀️
We're more than happy to accept pull requests 💪
- check our contributing page
- found a bug or have a question? Please create an issue.
License 📜
project_name is licensed under Apache 2
. View license.