Latest 0.1.8
Homepage https://github.com/eaceto/BugReporter
License MIT
Platforms ios 8.0
Dependencies SwiftyJSON
Frameworks MessageUI, Photos
Authors

CI Status
Version
License
Platform
Twitter

BugReporter is a simple and elegant bug reporting tool for you apps.

Features

  • [x] Detect ‘take screenshot’ event and fire a report
  • [x] Create a report with information about the device and the application
  • [x] Send report using email as channel
  • [x] Send report using UIActivityViewController as channel
  • [x] User can select how to send reports
  • [x] User can dismiss sending a report
  • [x] Load configuration from a property file (plist)
  • [x] Notify reporting life cycle
  • [ ] Detect shake gesture and fire a report
  • [ ] Attach multiple images to a report
  • [ ] Save report into file system if cannot be sent
  • [ ] Send report to a backend

What BugReporter is not

  • BugReporter is not a crash reporting tool (like Crashlytics).
  • BugReporter will not take screenshots of your app unless the user triggers a report event.

How to setup

Include a file named BugReporterSettings.plist inside your project. The content of this property file should have at least one property called applicationId with a non-empty string value. This property will be used in future versions when integrating with a backend.

reportsEMail

This property lets you specify a list of emails, used as default addresses when sending a report through email.

Example file

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>applicationId</key>
    <string>YOUR-APP-ID</string>
    <key>reportEMails</key>
    <array>
            <string>[email protected]</string>
            <string>[email protected]</string>
            <string>[email protected]</string>        
    </array>
</dict>
</plist>

Requirements

  • iOS 8.0+
  • Xcode 8.1+
  • Swift 3.0+

Communication

  • If you need help, write me an e-mail
  • If you found a bug, open an issue.
  • If you have a feature request, open an issue.
  • If you want to contribute, submit a pull request.

Installation

BugReporter is available through CocoaPods. To install
it, simply add the following line to your Podfile:

pod "BugReporter"

Usage

To run the example project, clone the repo, and run pod install from the Example directory first.

Author

Ezequiel Aceto, ezequiel.aceto (at) gmail.com

License

BugReporter is available under the MIT license. See the LICENSE file for more info.

Latest podspec

{
    "name": "BugReporter",
    "version": "0.1.8",
    "summary": "A simple and elegant bug reporting tool for you apps.",
    "description": "Bug Reporter is a tool that simplifies the process of reporting bugs and comments from users to developers.",
    "homepage": "https://github.com/eaceto/BugReporter",
    "license": {
        "type": "MIT",
        "file": "LICENSE"
    },
    "authors": {
        "Kimi": "[email protected]"
    },
    "source": {
        "git": "https://github.com/eaceto/BugReporter.git",
        "tag": "0.1.8"
    },
    "social_media_url": "https://twitter.com/eaceto",
    "platforms": {
        "ios": "8.0"
    },
    "source_files": "BugReporter/Classes/**/*",
    "resource_bundles": {
        "BugReporter": [
            "BugReporter/Assets/**/*"
        ]
    },
    "frameworks": [
        "MessageUI",
        "Photos"
    ],
    "dependencies": {
        "SwiftyJSON": [
            "~> 3.1"
        ]
    },
    "pushed_with_swift_version": "3.0"
}

Pin It on Pinterest

Share This