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: 19 days 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 (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-06T02:15:28.000Z (6 months ago)
• Last Synced: 2024-10-18T06:44:14.296Z (23 days 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: 365
• Watchers: 12
• Forks: 10
• Open Issues: 48
• 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)                       | [![pub package](https://img.shields.io/pub/v/fluttium.svg)](https://pub.dev/packages/fluttium)                       |

| [fluttium_cli](https://github.com/wolfenrain/fluttium/tree/main/packages/fluttium_cli)               | [![pub package](https://img.shields.io/pub/v/fluttium_cli.svg)](https://pub.dev/packages/fluttium_cli)               |

| [fluttium_driver](https://github.com/wolfenrain/fluttium/tree/main/packages/fluttium_driver)         | [![pub package](https://img.shields.io/pub/v/fluttium_driver.svg)](https://pub.dev/packages/fluttium_driver)         |

| [fluttium_interfaces](https://github.com/wolfenrain/fluttium/tree/main/packages/fluttium_interfaces) | [![pub package](https://img.shields.io/pub/v/fluttium_interfaces.svg)](https://pub.dev/packages/fluttium_interfaces) |

| [fluttium_protocol](https://github.com/wolfenrain/fluttium/tree/main/packages/fluttium_protocol)     | [![pub package](https://img.shields.io/pub/v/fluttium_protocol.svg)](https://pub.dev/packages/fluttium_protocol)     |

## Actions

| Action                                                                            | Pub                                                                                                |

|-----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|

| [log_action](https://github.com/wolfenrain/fluttium/tree/main/actions/log_action) | [![pub package](https://img.shields.io/pub/v/log_action.svg)](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.