devenlu / buglife-ios Goto Github PK

Buglife is an awesome bug reporting SDK & web platform for iOS apps. Here's how it works:

1. User takes a screenshot, or stops screen recording
2. User annotates their screenshot & writes feedback
3. Bug reports are pushed to your team's email/Jira/Slack/Asana/wherever you track bugs.

You can also find Buglife for Android here.

To integrate Buglife into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'Buglife'

Then, run the following command:

$ pod install

1. Download the Buglife SDK

2. Unzip it & pull Buglife.framework into the Frameworks group in your project. In the following dialog box, make sure you have "Copy items if needed" checked.

1. Import the Buglife framework header into your app delegate.

   // Swift
   import Buglife

   // Objective-C
   #import <Buglife/Buglife.h>

2. Add the following to your app delegate's application:didFinishLaunchingWithOptions: method.

   // Swift
   Buglife.shared().start(withEmail: "[email protected]")

   // Objective-C
   [[Buglife sharedBuglife] startWithEmail:@"[email protected]"];

   Be sure to replace [email protected] with your own email address; this is where bug reports will be sent to.

Build & run your app. Once your app is running, shake your device (^⌘Z in the simulator) to report a bug! Bug reports are sent directly to your email address.

You can customize how the bug reporter is invoked. Rather than shake, we recommend configuring the bug reporter to be shown when a user takes a screenshot:

// Swift
Buglife.shared().invocationOptions = .screenshot

// Objective-C
[Buglife sharedBuglife].invocationOptions = LIFEInvocationOptionsScreenshot;

To learn more about customizing Buglife, refer to the documentation.

• Xcode 8 or later
• iOS 9 or later

We don't have any contributing guidelines at the moment, but feel free to submit pull requests & file issues within GitHub!