Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kennytian/react-native-instabug

In-App Conversations and Bug Reporting for React Native
https://github.com/kennytian/react-native-instabug

Last synced: about 2 months ago
JSON representation

In-App Conversations and Bug Reporting for React Native

Awesome Lists containing this project

README

        

## React Native plugin for the Instabug service

README: [English](https://github.com/Kennytian/react-native-instabug/) | [中文](https://github.com/Kennytian/react-native-instabug/blob/master/README_CHINESE.md)

[![Build Status](https://travis-ci.org/Kennytian/react-native-instabug.svg?branch=develop)](https://travis-ci.org/Kennytian/react-native-instabug.svg?branch=develop)
[![npm version](http://img.shields.io/npm/v/react-native-instabug.svg?style=flat-square)](https://npmjs.org/package/react-native-instabug "View this project on npm")
[![npm version](http://img.shields.io/npm/dm/react-native-instabug.svg?style=flat-square)](https://npmjs.org/package/react-native-instabug "View this project on npm")
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
[![Github Issues](http://githubbadges.herokuapp.com/pikesley/githubbadges/issues.svg)](https://github.com/Kennytian/react-native-instabug/issues)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Kennytian/react-native-instabug/pulls)

[The Simplest In-App Feedback and Bug Reportng for Mobile Apps! ](https://instabug.com/developers)

![Android Demo](http://ww4.sinaimg.cn/mw690/77c29b23gw1f8hrrg0ie1j20hu0qk404.jpg)

### Getting Started

`npm install --save react-native-instabug`

### Mostly automatic installation

`react-native link react-native-instabug`

### Manual installation
#### Android
Edit android/settings.gradle to look like this:

```diff
include ':app'

+ include ':react-native-instabug'
+ project(':react-native-instabug').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-instabug/android')
```

Edit android/app/build.gradle to look like this:
```diff
dependencies {
compile fileTree(dir: "libs", include: ["*.jar"])
compile "com.android.support:appcompat-v7:23.0.1"
compile "com.facebook.react:react-native:+" // From node_modules
+ compile project(':react-native-instabug')
}
```

only RN 0.29+ Edit your MainApplication.java (deep in android/app/src/main/java/...) to look like this (note two places to edit):
```diff
+ import com.kenny.instabug.InstabugPackage;
...
new MainReactPackage(),
+ new InstabugPackage("your_app_token_here", MainApplication.this)
}
```

#### iOS
```diff
- Welcome iOS developer join, write this component together!
```

1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
2. Go to `node_modules` ➜ `react-native-instabug` and add `ios/RCTInstabug.xcodeproj`
3. In XCode, in the project navigator, select your project. Add `libRCTInstabug.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`
4. Run your project (`Cmd+R`)<

### Usage

To see all available function take a look at [index.android.js](https://github.com/Kennytian/react-native-instabug/blob/master/example/index.android.js#L41)

```js
_testShowIntroMessage() {
Instabug.showIntroMessage();
}

_testInstabug() {
Instabug.setUserEmail('[email protected]');
Instabug.setUserData('This is your committed user data');
Instabug.setUsername('Your user name');
Instabug.addTags('react-native,bug,feedback,instabug');
Instabug.changeInvocationEvent('Shake');
Instabug.reportBug();
}
```
### Credits
* @prithsharma https://github.com/prithsharma
* @emmaplus https://github.com/emmaplus
* @delfrrr https://github.com/delfrrr