Install Shake

Install

Add shake as a dependency to pubspec.yaml.

pubspec.yaml

dependencies:

shake_flutter:

Run flutter pub get to download the package.

Then include Shake package in your code

lib/main.dart

import 'package:shake_flutter/shake_flutter.dart';

Add Client ID and Secret

Android

Open your AndroidManifest.xml file. Paste this and replace your-api-client-id and your-api-client-secret with the actual values you have in your workspace settings.

AndroidManifest.xml

<manifest xmlns:android="http://schemas.android.com/apk/res/android">

<application

android:allowBackup="true"

android:icon="@mipmap/ic_launcher"

android:label="@string/app_name"

android:theme="@style/AppTheme" >

<activity android:name=".MainActivity" android:label="@string/app_name" >

<intent-filter>

<action android:name="android.intent.action.MAIN" />

<category android:name="android.intent.category.LAUNCHER" />

</intent-filter>

</activity>

<meta-data

android:name="com.shakebugs.APIClientID"

android:value="your-api-client-id" />

<meta-data

android:name="com.shakebugs.APIClientSecret"

android:value="your-api-client-secret" />

</application>

<uses-permission android:name="android.permission.INTERNET" />

</manifest>

iOS

Open your workspace and in the Project Navigator, right click on Info.plist, and Open as › Source code. Paste this but replace your-api-client-id and your-api-client-secret with the actual values you have in your workspace settings.

Info.plist

<?xml version="1.0" encoding="utf-8" ?>

<plist version="1.0">

<dict>

<key>Shake</key>

<dict>

<key>APIClientID</key>

<string>your-api-client-id</string>

<key>APIClientSecret</key>

<string>your-api-client-secret</string>

</dict>

</dict>

</plist>

ProGuard

If you are using code shrinking when building your application, add following ProGuard rule to the proguard-rules.pro file:

proguard-rules.pro

-keep class com.shakebugs.** { *; }

note

Building release .apk or .app using flutter build will run code shrinking by default.

Initialize

To start Shake, enable desired invocation methods and then call Shake.start() like in the example below.

lib/main.dart

import 'package:shake_flutter/shake_flutter.dart';

void main() {

WidgetsFlutterBinding.ensureInitialized();

Shake.setShowFloatingReportButton(true);

Shake.setInvokeShakeOnShakeDeviceEvent(true);

Shake.setInvokeShakeOnScreenshot(true);

Shake.start();

runApp(Home());

}

note

Shake supports post Flutter 1.12 projects. If your project is created with the older version of Flutter, you should migrate your project to the new Android APIs via official guide.

note

Shake supports devices with Android 7.0 version and higher.