https://github.com/wolfenrain/fluttium
Fluttium, the user flow testing tool for Flutter
https://github.com/wolfenrain/fluttium
cli command-line command-line-tool dart dart-package flutter flutter-package ui-testing
Last synced: about 1 year ago
JSON representation
Fluttium, the user flow testing tool for Flutter
- Host: GitHub
- URL: https://github.com/wolfenrain/fluttium
- Owner: wolfenrain
- License: mit
- Created: 2022-10-08T17:41:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-06T02:15:28.000Z (almost 2 years ago)
- Last Synced: 2025-03-29T00:12:47.347Z (about 1 year ago)
- Topics: cli, command-line, command-line-tool, dart, dart-package, flutter, flutter-package, ui-testing
- Language: Dart
- Homepage: https://fluttium.dev
- Size: 4.17 MB
- Stars: 368
- Watchers: 9
- Forks: 10
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
---
Fluttium, the user flow testing tool for Flutter.
![Fluttium Demo][fluttium_demo]
## Packages
| Package | Pub |
|------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
| [fluttium](https://github.com/wolfenrain/fluttium/tree/main/packages/fluttium) | [](https://pub.dev/packages/fluttium) |
| [fluttium_cli](https://github.com/wolfenrain/fluttium/tree/main/packages/fluttium_cli) | [](https://pub.dev/packages/fluttium_cli) |
| [fluttium_driver](https://github.com/wolfenrain/fluttium/tree/main/packages/fluttium_driver) | [](https://pub.dev/packages/fluttium_driver) |
| [fluttium_interfaces](https://github.com/wolfenrain/fluttium/tree/main/packages/fluttium_interfaces) | [](https://pub.dev/packages/fluttium_interfaces) |
| [fluttium_protocol](https://github.com/wolfenrain/fluttium/tree/main/packages/fluttium_protocol) | [](https://pub.dev/packages/fluttium_protocol) |
## Actions
| Action | Pub |
|-----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| [log_action](https://github.com/wolfenrain/fluttium/tree/main/actions/log_action) | [](https://pub.dev/packages/log_action) |
## Quick Start
```shell
# 📦 Install from pub.dev
flutter pub global activate fluttium_cli
# 🖥 Create a test flow file
fluttium new flow my_flow --description "My cool flow"
# 🧪 Run a test flow file
fluttium test my_flow.yaml
```
## Documentation
View the full documentation [here](https://fluttium.dev/).
## Examples
The [example](https://github.com/wolfenrain/fluttium/tree/main/example) directory contains
[example user flows](https://github.com/wolfenrain/fluttium/tree/main/example/flows) that are
written for the example application.
These tests are used for testing of new features and will be kept up to date.
[fluttium_demo]: https://raw.githubusercontent.com/wolfenrain/fluttium/main/docs/static/img/hero.gif
## Contributing
Have you found a bug or have a suggestion of how to enhance Fluttium? Open an issue and we will
take a look at it as soon as possible.
Do you want to contribute with a PR? PRs are always welcome, just make sure to create it from the
correct branch (main) and follow the [checklist](.github/pull_request_template.md) which will
appear when you open the PR.