sha

Shakedown

Simple bug reporting for human beings.

Showing:

Popularity

Downloads/wk

0

GitHub Stars

52

Maintenance

Last Commit

8yrs ago

Contributors

1

Package

Dependencies

0

License

MIT

Categories

Readme

Shakedown

Simple, in-app bug reporting for human beings.

Setup

To get going, just clone the repo and drag the contents of your repository into your project, and call [SHDShakedown sharedShakedown] at launch.

Triggers

By default, Shakedown will begin listening for shake events automatically on debug builds. You can also call showButton on SHDShakedown, which will display a button in the status bar of the application (if it has one).

Reporting Method

It is highly recommended to configure a reporter to suit your specific needs.

Configuring the Reporter

For example, you can configure the email reporter like so:

SHDShakedownEmailReporter *reporter = [[SHDShakedownEmailReporter alloc] init];
reporter.recipient = @"bugs@test.com";
[SHDShakedown sharedShakedown].reporter = reporter;

Various reporters will have different things to configure. For example, one that posts to on online service may need an API key or login credentials, or what project to pust bugs to.

Included Reporters

Supported iOS Versions

Shakdown works on iOS 5.0 and up.

A note on ARC

Shakedown uses ARC. To get things working in a non-ARC project, set the -fobjc-arc compiler flag on all the files prefixed with SHD.

Private API Usage & Preprocessor Flags

Shakedown uses the private API UIGetScreenImage(). This allows us to capture whatever's on the screen (including some fancier OpenGL stuff), but is not permitted by Apple in the App Store. The relevant calls are wrapped in an #ifdef DEBUG call, so it will be compiled out in App Store builds, but please be aware of it. Shakedown will, by default only initialize on builds with the DEBUG flag set. If you want to do a Release build with Shakedown enabled (for example, for TestFlight), you can define an ADHOC preprocessor flag.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial