https://github.com/instabug/instabug-cordova

Instabug's Plugin for Cordova
https://github.com/instabug/instabug-cordova

Last synced: about 1 month ago
JSON representation

Instabug's Plugin for Cordova

• Host: GitHub
• URL: https://github.com/instabug/instabug-cordova
• Owner: Instabug
• Created: 2016-06-29T13:01:07.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-06-20T07:30:10.000Z (5 months ago)
• Last Synced: 2024-10-11T10:40:50.329Z (about 1 month ago)
• Language: Java
• Homepage: https://instabug.com/
• Size: 445 MB
• Stars: 23
• Watchers: 35
• Forks: 25
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Instabug Cordova Plugin

The purpose of this plugin is to simplify the process of integrating the Instabug SDK in a hybrid application, as well as to provide an interface to interact with the SDK through JavaScript.

Instabug is a bug reporting and in-app feedback tool that provides your testers and users with easy “shake to send” feedback from within the app, to [report bugs and issues easily](https://instabug.com/bug-reporting). You’ll get attached screenshots, screen recordings, annotations, network logs to help you take insightful decisions. You’ll also receive all the device details, environment snapshots and bug reproduction steps so that you can fix bugs and iterate faster.

For more info, visit [Instabug.com](https://instabug.com).

## Installation

### Cordova:

```

cordova plugin add instabug-cordova

```

### Ionic:

```

ionic cordova plugin add instabug-cordova

```

## Integration Steps

- Add the following snippet to your `index.js` file inside `onDeviceReady` function:   

```js

var Instabug = cordova.require('instabug-cordova.Instabug');

var BugReporting = cordova.require('instabug-cordova.BugReporting');

Instabug.start(

    'YOUR_CORDOVA_TOKEN',

    [BugReporting.invocationEvents.button],

    function () {

        console.log('Instabug initialized.');

    },

    function (error) {

        console.log('Instabug could not be initialized - ' + error);

    }

);

```

- Replace `YOUR_CORDOVA_TOKEN` with your application token.

> :warning:  If you're updating the SDK from versions prior to v11, please check our [migration guide](https://docs.instabug.com/docs/cordova-migration-guide).

## Features Not Yet Supported

- User steps.

- Repro steps.

- Network logging.

- View hierarchy.

- Crash reporting.

- Push notification for in-app messaging.

## License

This software is released under the Apache 2.0 License.

© 2022 Instabug. All rights reserved.