{"repo":"square/Aardvark","free":true,"listed":false,"github":"https://github.com/square/Aardvark","clone":"git clone https://github.com/square/Aardvark.git","description":"Aardvark is a library that makes it dead simple to create actionable bug reports.","language":"Objective-C","stars":262,"topics":["ios","bug-reporting","logging"],"license":"Apache-2.0","category":"mobile-apps","readme_excerpt":"Aardvark Aardvark makes it dead simple to create actionable bug reports. Aardvark is made up of a collection of frameworks that provide different bug reporting and logging components. CoreAardvark - The core structures for Aardvark. Safe to run in app extensions. Aardvark - The core tools for building a bug report. AardvarkMailUI - A bug reporter implementation that sends the bug report via an email composer. AardvarkLoggingUI - UI components for viewing Aardvark logs in an iOS app. Getting Started There are only three steps to get Aardvark logging and bug reporting up and running. 1) Install Aardvark The easiest way to get Aardvark up and running is to add a dependency on the AardvarkMailUI framework. Using CocoaPods Using Carthage Using Git Submodules Manually checkout the submodule with git submodule add git@github.com:Square/Aardvark.git , drag Aardvark.xcodeproj to your project, and add AardvarkMailUI as a build dependency. 2) Set up email bug reporting with a single method call It is best to do this when you load your application’s UI. In Swift: In Objective-C: 3) Replace calls to print with log . In Swift, replace calls to print with log . In Objective-C, replace calls to NSLog with ARKLog . Reporting Bugs After doing the above, your users can report a bug by making a two-finger long-press gesture. This gesture triggers a UIAlert asking the user what went wrong. When the user enters this information, an email bug report is generated complete with an attached app screen","default_branch":null,"files":null,"tree":[],"storefront":"/r/square","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/square/Aardvark/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}