https://github.com/abichinger/github-issues
Flutter package to create Github issues
https://github.com/abichinger/github-issues
dart dart-package feedback flutter issue-tracker
Last synced: 7 months ago
JSON representation
Flutter package to create Github issues
- Host: GitHub
- URL: https://github.com/abichinger/github-issues
- Owner: abichinger
- License: mit
- Created: 2023-09-07T12:01:22.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-12T20:58:39.000Z (about 2 years ago)
- Last Synced: 2025-01-24T17:48:04.272Z (9 months ago)
- Topics: dart, dart-package, feedback, flutter, issue-tracker
- Language: Dart
- Homepage:
- Size: 1.08 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Github Issues
[](https://pub.dev/packages/github_issues)
Use Github issues to collect user feedback.
## Features
- Create Github issues with title, comment and labels
- Easy internationalization with `GithubIssuesLocalizations`
- Supports two authentication methods
## Getting started
1. Create a repository to store the user feedback (or use an existing one).
2. Get a token with read and write access on issues for your repository
**Option 1**: [Generate a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
**Option 2**: Create a [Github App](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) -> [Install](https://docs.github.com/en/enterprise-cloud@latest/apps/using-github-apps/installing-your-own-github-app) your own Github App -> [Generate a private key](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps) for your Github App.
## Usage
[Full example](https://pub.dev/packages/github_issues/example)
**Fill input fields in advance**:
```dart
showDialog(
context: context,
builder: (context) {
return GithubIssueDialog(
github: Github(Authentication.token('PERSONAL_ACCESS_TOKEN'));,
owner: 'OWNER',
repo: 'REPO',
initialValue: const IssueRequest(title: "Hello World!"),
);
},
);
```
**Pass your custom localizations**:
```dart
class CustomLocalization extends GithubIssuesLocalizationsEn {
@override
String get dialogTitle => 'Thanks for your feedback!';
}
showDialog(
context: context,
builder: (context) {
return GithubIssueDialog(
github: Github(Authentication.token('PERSONAL_ACCESS_TOKEN'));,
owner: 'OWNER',
repo: 'REPO',
localizations: CustomLocalization(),
);
},
);
```
**Show only comment input**:
```dart
showDialog(
context: context,
builder: (context) {
return GithubIssueDialog(
github: Github(Authentication.token('PERSONAL_ACCESS_TOKEN'));,
owner: 'OWNER',
repo: 'REPO',
showTitle: false,
labels: null,
initialValue: const IssueRequest(title: "Hidden Title"), // title is required
);
},
);
```