Skip to content

Latest commit

 

History

History
111 lines (82 loc) · 4.39 KB

README.md

File metadata and controls

111 lines (82 loc) · 4.39 KB
Raw

Wiredash SDK for Flutter

Pub Build Pub Likes Popularity Pub points Website

wiredash.com | Console | Pub | Documentation | Get Started

  • 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 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

Wiredash Logo

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 for the in-depth guide and additional info.

1. Create an account and project

Start by visiting the Wiredash Console: Wiredash 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

$ flutter pub add wiredash:^2.3.0
dependencies:
  flutter:
    sdk: flutter
  ...
  wiredash: ^2.3.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 > Your project > Settings > General Settings.

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.

FloatingActionButton(
  onPressed: () {
    Wiredash.of(context).show(inheritMaterialTheme: true);
  },
  child: Icon(Icons.feedback_outlined),
),

Checkout examples/theming for the full example or head to the documentation for more info.

Launch the Promoter Score Survey

FloatingActionButton(
  onPressed: () {
  Wiredash.of(context).showPromoterSurvey(force: true);
  },
  child: Icon(Icons.feedback_outlined),
),

Checkout examples/promoter_score for the full example or head to the documentation for more info.

License

The Wiredash SDK is released under the Attribution Assurance License which is redundant with BSD. See LICENSE for details.