diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml new file mode 100644 index 0000000..33826d0 --- /dev/null +++ b/.github/dependabot.yaml @@ -0,0 +1,10 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + - package-ecosystem: "pub" + directory: "/" + schedule: + interval: "daily" \ No newline at end of file diff --git a/.github/workflows/flutter.yml b/.github/workflows/flutter.yml new file mode 100644 index 0000000..dc6b270 --- /dev/null +++ b/.github/workflows/flutter.yml @@ -0,0 +1,32 @@ +name: CI + +on: + push: + branches: [ master ] + pull_request: + branches: + - master + - feature/* + - bugfix/* + - hotfix/* + +jobs: + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/cache@v3 + with: + path: | + ~/.gradle/wrapper + /opt/hostedtoolcache/flutter + key: ${{ runner.OS }}-flutter-install-cache + - uses: subosito/flutter-action@v2 + with: + channel: 'stable' + - name: Flutter pub get + run: flutter pub get + - name: Flutter format + run: flutter format -o none --set-exit-if-changed . + - name: Flutter analyze + run: flutter analyze \ No newline at end of file diff --git a/README.md b/README.md index 145e29f..e29e79a 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ [![pub package](https://img.shields.io/pub/v/bottom_alert_dialog.svg)](https://github.com/Iconica-Development) [![Build status](https://github.com/Iconica-Development/flutter_registration)](https://github.com/Iconica-Development/flutter_registration/actions/new) [![style: effective dart](https://img.shields.io/badge/style-effective_dart-40c4ff.svg)](https://github.com/tenhobi/effective_dart) +# Flutter Registration -Registration plug-in. +Flutter Registration is a package to easily implement +a registration flow in your app. -## Install +![Registration GIF](flutter_registration.gif) -To use this package, add `flutter_registration` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/platform-integration/platform-channels). +## Setup -## Configure +To use this package, add `flutter_registration` as a dependency in your pubspec.yaml file. + +## How to use To configure the registration plug-in use the ```RegistrationScreen``` widget. @@ -44,6 +48,8 @@ class ExampleRegistrationRepository with RegistrationRepository { } ``` +See the [Example Code](example/lib/main.dart) for an example on how to use this package. + ## Issues Please file any issues, bugs or feature request as an issue on our [GitHub](https://github.com/Iconica-Development/flutter_registration) page. Commercial support is available if you need help with integration with your app or services. You can contact us at [support@iconica.nl](mailto:support@iconica.nl). @@ -54,4 +60,4 @@ If you would like to contribute to the plugin (e.g. by improving the documentati ## Author -This flutter_registration for Flutter is developed by [Iconica](https://iconica.nl). You can contact us at \ No newline at end of file +This `flutter_registration` for Flutter is developed by [Iconica](https://iconica.nl). You can contact us at \ No newline at end of file diff --git a/flutter_registration.gif b/flutter_registration.gif new file mode 100644 index 0000000..c805371 Binary files /dev/null and b/flutter_registration.gif differ