Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wiredashio/wiredash-sdk
Interactive user feedback tool for Flutter 🎉
https://github.com/wiredashio/wiredash-sdk
analytics feedback flutter nps
Last synced: about 2 months ago
JSON representation
Interactive user feedback tool for Flutter 🎉
- Host: GitHub
- URL: https://github.com/wiredashio/wiredash-sdk
- Owner: wiredashio
- License: other
- Created: 2020-03-10T09:21:01.000Z (almost 5 years ago)
- Default Branch: stable
- Last Pushed: 2024-10-28T02:53:41.000Z (about 2 months ago)
- Last Synced: 2024-10-28T04:11:19.037Z (about 2 months ago)
- Topics: analytics, feedback, flutter, nps
- Language: Dart
- Homepage: https://pub.dev/packages/wiredash
- Size: 7.53 MB
- Stars: 513
- Watchers: 11
- Forks: 66
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Wiredash SDK for Flutter
[](https://pub.dartlang.org/packages/wiredash)
[](https://github.com/wiredashio/wiredash-sdk/actions)
[](https://pub.dev/packages/wiredash/score)
[](https://pub.dev/packages/wiredash/score)
[](https://pub.dev/packages/wiredash/score)
[](https://wiredash.com/)
[wiredash.com](https://wiredash.com) | [Console](https://wiredash.com/console) | [Pub](https://pub.dev/packages/wiredash) | [Documentation](https://docs.wiredash.com) | [Get Started](https://docs.wiredash.com/guide/start)
- **Real-time analytics**: Get real-time analytics that is GDPR-compliant and hosted in the EU 🇪🇺
- **Capture in-app user feedback**: Get direct user feedback from within your app with screenshots and tags
- **Schedule promoter score surveys**: Schedule and automate promoter score surveys.
- **Console**: The Wiredash [console](https://wiredash.com/console) provides a dashboard to access your feedback and analytics
- **Universal compatibility**: Written in Dart, Wiredash is compatible with Android, iOS, Web, macOS, Windows, Linux, and IoT
- **Free**: Wiredash is free for up to 100.000 monthly active devices
From members of the Flutter Community 💙 for the Flutter Community 💙
## 3-Minute Quick Start
> It takes less than 180 seconds to integrate Wiredash in your existing app 🚀
> Visit [docs.wiredash.com](https://docs.wiredash.com/guide/start) for the in-depth
> guide and additional info.
### 1. Create an account and project
Start by visiting the Wiredash Console: [Wiredash Console](https://wiredash.com/console).
Create your free account using Google or GitHub or request an email sign-in link.
Then create a project with a descriptive name.
### 2. Add Wiredash to your pubspec.yaml
```bash
$ flutter pub add wiredash:^2.2.0
```
```yaml
dependencies:
flutter:
sdk: flutter
...
wiredash: ^2.2.0
```
### 3. Wrap your root widget with Wiredash
Wrap the root widget of your existing app with Wiredash and make sure to fill in the `projectId` and SDK `secret`
from the [Wiredash Console](https://console.wiredash.com) > Your project >
Settings > General Settings.
```dart
import 'package:flutter/material.dart';
import 'package:wiredash/wiredash.dart';
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return Wiredash(
projectId: 'YOUR-PROJECT-ID',
secret: 'YOUR-SECRET',
child: MaterialApp(
// Your Flutter app is basically Wiredash's direct child.
// This can be a MaterialApp, WidgetsApp or whatever widget you like.
),
);
}
}
```
That's already it. Yes, it's *really that easy*.
### 4. (Optional) More features
#### Launch the feedback flow
Call the `Wiredash.of(context).show()` method from anywhere in your app to launch the Wiredash Feedback flow.
```dart
FloatingActionButton(
onPressed: () {
Wiredash.of(context).show(inheritMaterialTheme: true);
},
child: Icon(Icons.feedback_outlined),
),
```
Checkout [examples/theming](https://github.com/wiredashio/wiredash-sdk/blob/stable/examples/theming/lib/main.dart) for the full example or head to the [documentation](https://docs.wiredash.com/reference/feedback) for more info.
#### Launch the Promoter Score Survey
```dart
FloatingActionButton(
onPressed: () {
Wiredash.of(context).showPromoterSurvey(force: true);
},
child: Icon(Icons.feedback_outlined),
),
```
Checkout [examples/promoter_score](https://github.com/wiredashio/wiredash-sdk/blob/stable/examples/promoter_score/lib/main.dart) for the full example or head to the [documentation](https://docs.wiredash.com/reference/promoter-score) for more info.
## License
The Wiredash SDK is released under the [Attribution Assurance License](https://opensource.org/licenses/AAL) which is redundant with [BSD](https://opensource.org/licenses/BSD-3-Clause).
See [LICENSE](https://github.com/wiredashio/wiredash-sdk/blob/stable/LICENSE) for details.