Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janheinrichmerker/android-issue-reporter
A powerful and simple library to open issues on GitHub directly from your app.
https://github.com/janheinrichmerker/android-issue-reporter
android android-library github-api issue-tracker jitpack material-design material-ui
Last synced: 3 days ago
JSON representation
A powerful and simple library to open issues on GitHub directly from your app.
- Host: GitHub
- URL: https://github.com/janheinrichmerker/android-issue-reporter
- Owner: janheinrichmerker
- License: mit
- Created: 2016-04-04T22:16:35.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-14T13:34:19.000Z (2 months ago)
- Last Synced: 2024-12-22T05:09:41.993Z (3 days ago)
- Topics: android, android-library, github-api, issue-tracker, jitpack, material-design, material-ui
- Language: Java
- Homepage:
- Size: 2.07 MB
- Stars: 118
- Watchers: 6
- Forks: 27
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/janheinrichmerker/android-issue-reporter/actions/workflows/ci.yml)
[](https://jitpack.io/#com.github.janheinrichmerker/android-issue-reporter)
[](https://android-arsenal.com/details/1/3413)
[](https://github.com/janheinrichmerker/android-issue-reporter/issues)
[](https://github.com/janheinrichmerker/android-issue-reporter/pulls)
[](https://github.com/janheinrichmerker/android-issue-reporter/commits)
[](https://github.com/janheinrichmerker/android-issue-reporter/graphs/contributors)
[](LICENSE)
# android-issue-reporter
Is your mailbox full of bug reports and feature requests from your app users? \
_android-issue-reporter_ is a new material designed library to report issues from your app directly to GitHub, even without an account.
This library is inspired by [Paolo Rotolo](https://github.com/PaoloRotolo)'s [Gitty Reporter](https://github.com/PaoloRotolo/GittyReporter)
## Demo
Download the demo app from the Google Play Store.
## Screenshots
|  |  |  |
|:-:|:-:|:-:|
| GitHub bot | Include device info | Demo |
## Installation
Add the _android-issue-reporter_ dependency to your app's `build.gradle` (or `build.gradle.kts`):
Groovy DSL
```gradle
dependencies {
implementation 'com.github.janheinrichmerker:android-issue-reporter:1.4.2'
}
```
Kotlin DSL
```kotlin
dependencies {
implementation("com.github.janheinrichmerker:android-issue-reporter:1.4.2")
}
```
Then, add the JitPack repository in your root `settings.gradle` (or `settings.gradle.kts`):
Groovy DSL
```gradle
dependencyResolutionManagement {
repositories {
maven { url 'https://jitpack.io' }
}
}
```
Kotlin DSL
```kotlin
dependencyResolutionManagement {
repositories {
maven(url = "https://jitpack.io")
}
}
```
Check out the latest dependency _android-issue-reporter_ from [jitpack.io](https://jitpack.io/#com.github.janheinrichmerker/android-issue-reporter).
## Usage
### Launch from anywhere with `IssueReporterLauncher`
Just start the issue reporter directly from your activity using the fluent launcher builder:
Java
```java
IssueReporterLauncher
.forTarget("janheinrichmerker", "android-issue-reporter")
// [Recommended] Theme to use for the reporter.
// (See #theming for further information.)
.theme(R.style.Theme_App_Dark)
// [Optional] Auth token to open issues if users don't have a GitHub account
// You can register a bot account on GitHub and copy ist OAuth2 token here.
// (See #how-to-create-a-bot-key for further information.)
.guestToken("28f479f73db97d912611b27579aad7a76ad2baf5")
// [Optional] Force users to enter an email address when the report is sent using
// the guest token.
.guestEmailRequired(true)
// [Optional] Set a minimum character limit for the description to filter out
// empty reports.
.minDescriptionLength(20)
// [Optional] Include other relevant info in the bug report (like custom variables)
.putExtraInfo("Test 1", "Example string")
.putExtraInfo("Test 2", true)
// [Optional] Disable the back arrow in the toolbar
.homeAsUpEnabled(false)
.launch(this);
```
Kotlin
```kotlin
IssueReporterLauncher
.forTarget("janheinrichmerker", "android-issue-reporter")
// [Recommended] Theme to use for the reporter.
// (See #theming for further information.)
.theme(R.style.Theme_App_Dark)
// [Optional] Auth token to open issues if users don't have a GitHub account
// You can register a bot account on GitHub and copy ist OAuth2 token here.
// (See #how-to-create-a-bot-key for further information.)
.guestToken("28f479f73db97d912611b27579aad7a76ad2baf5")
// [Optional] Force users to enter an email address when the report is sent using
// the guest token.
.guestEmailRequired(true)
// [Optional] Set a minimum character limit for the description to filter out
// empty reports.
.minDescriptionLength(20)
// [Optional] Include other relevant info in the bug report (like custom variables)
.putExtraInfo("Test 1", "Example string")
.putExtraInfo("Test 2", true)
// [Optional] Disable the back arrow in the toolbar
.homeAsUpEnabled(false)
.launch(this)
```
### Extending `IssueReporterActivity`
Alternatively, if you need to further customize the issue reporter, create a new `Activity` class that extends `IssueReporterActivity`:
Java
```java
public class ExampleReporterActivity extends IssueReporterActivity {
// Where should the issues go?
// (http://github.com/username/repository)
@Override
public GithubTarget getTarget() {
return new GithubTarget("username", "repository");
}
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// [Optional] Auth token to open issues if users don't have a GitHub account
// You can register a bot account on GitHub and copy ist OAuth2 token here.
// (See #how-to-create-a-bot-key for further information.)
setGuestToken("28f479f73db97d912611b27579aad7a76ad2baf5")
// [Optional] Force users to enter an email adress when the report is sent using
// the guest token.
setGuestEmailRequired(true);
// [Optional] Set a minimum character limit for the description to filter out
// empty reports.
setMinimumDescriptionLength(20);
}
// [Optional] Include other relevant info in the bug report (like custom variables)
@Override
public void onSaveExtraInfo(ExtraInfo extraInfo) {
extraInfo.put("Test 1", "Example string");
extraInfo.put("Test 2", true);
}
}
```
Kotlin
```kotlin
class ExampleReporterActivity : IssueReporterActivity() {
// Where should the issues go?
// (http://github.com/username/repository)
override fun getTarget(): GithubTarget {
return GithubTarget("username", "repository")
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// [Optional] Auth token to open issues if users don't have a GitHub account
// You can register a bot account on GitHub and copy ist OAuth2 token here.
// (See #how-to-create-a-bot-key for further information.)
setGuestToken("28f479f73db97d912611b27579aad7a76ad2baf5")
// [Optional] Force users to enter an email adress when the report is sent using
// the guest token.
setGuestEmailRequired(true)
// [Optional] Set a minimum character limit for the description to filter out
// empty reports.
setMinimumDescriptionLength(20)
}
// [Optional] Include other relevant info in the bug report (like custom variables)
override fun onSaveExtraInfo(extraInfo: ExtraInfo) {
extraInfo.put("Test 1", "Example string")
extraInfo.put("Test 2", true)
}
}
```
### Theming
Create a theme extending `Theme.IssueReporter` theme and set it to the launcher using `IssueReporterLauncher.theme(@StyleRes int theme)` or declare it in `AndroidManifest.xml` if you have extended `IssueReporterActivity`:
```xml
<item name="colorPrimary">...</item><!-- required -->
<item name="colorPrimaryDark">...</item><!-- required -->
<item name="colorAccent">...</item><!-- required -->
```
### Creating a GitHub bot key
1. Create a new GitHub account. _(You have to use a unique email address.)_
2. Go to https://github.com/settings/tokens and create a new token using Generate new token. _(Only the `public_repo` permission is needed.)_
3. Copy the OAuth access token you get at the end of the setup.
4. Use the token in `IssueReporterLauncher.theme(String token)` or override `getGuestToken()` in your reporter activity like this:
Java
```java
@Override
public String getGuestToken() {
return "";
}
```
Kotlin
```kotlin
override fun getGuestToken(): String {
return ""
}
```
### Known Limitations
- Two factor authentication is not supported.
## Development
To contribute to the _android-issue-reporter_ library, just [create a codespace](https://codespaces.new/janheinrichmerker/android-issue-reporter) from this repository or clone it in an editor that supports [Dev Containers](https://containers.dev/) (e.g., [Visual Studio Code](https://code.visualstudio.com/learn/develop-cloud/containers) or [IntelliJ](https://www.jetbrains.com/help/idea/connect-to-devcontainer.html)).
All required dependencies will automatically be installed for you. \
Once ready, [create a pull request](https://github.com/janheinrichmerker/android-issue-reporter/compare) with your changes. We're happy to any contribution!
## Support
If you hit any problems using _android-issue-reporter_, please file an [issue](https://github.com/janheinrichmerker/android-issue-reporter/issues). We're happy to help!
## License
This repository is released under the [MIT license](LICENSE).
If you like _android-issue-reporter_, consider [sponsoring me](https://github.com/sponsors/janheinrichmerker).