Skip to main content



Execute the npm install command in your terminal:

npm install @shakebugs/react-native-shake

If you use React Native version 0.60 or greater, you should also run the add command:

react-native add-shake

If you use React Native version lower than 0.60, you should run the link command instead:

react-native link @shakebugs/react-native-shake

Install pods from the project root directory:

cd ios && pod install && cd ..

After the installation also run pod update Shake to be perfectly sure you're using the latest Shake .

Set compileSdkVersion version in the build.gradle file

Since Shake requires compileSdkVersion 29 or greater, verify that compileSdkVersion is correctly set in the build.gradle file.

buildscript {
ext {
buildToolsVersion = "30.0.2"
minSdkVersion = 21
compileSdkVersion = 30
targetSdkVersion = 30
ndkVersion = "20.1.5948944"
repositories {
dependencies {

Initialize Shake

Call Shake.start() method in your index.js file. Replace your-api-client-id and your-api-client-secret with the actual values you have in your workspace settings.

import {AppRegistry} from 'react-native';
import App from './src/App';
import {name as appName} from './app.json';
import Shake from '@shakebugs/react-native-shake';
AppRegistry.registerComponent(appName, () => App);
Shake.start('your-api-client-id', 'your-api-client-secret');

Now build your project and see everything work!

To build and run your app, first run react-native start command in the terminal. Use react-native run-android command to run your app on the Android device. Or use react-native run-ios command to run your app on the iOS device.

This first run will automatically add your app to your Shake Dashboard based on your app application ID.