/GitHub-Activity-Feed

A Flutter application for viewing a rich feed of GitHub activity.

Primary LanguageDartGNU General Public License v3.0GPL-3.0

github_activity_feed

A Flutter application for viewing a rich feed of GitHub activity.

Generic badge

Project status:

Public Preview: Version 0.8.2

Supported platforms: Android, iOS (see notes)

Please note that apk's posted to releases are not signed during the public preview phase.

Please note that in order to use this application on iOS you will need to build it yourself. I do not yet have an Apple Developer Account and so I cannot put the app on Testflight.

Implemented Features:

  • View activity for all users you follow in one place. Tapping on the repository preview section of an activity card or a user will open that repository or user page in the browser (or another GitHub application installed on your device).
  • Search for users
  • Send direct feedback to the developer within the app

Initial Release Roadmap:

See the initial release project board

Contributing:

  • This project uses the GitHub api. It uses the v3 REST api for authentication through my fork of the github package on pub and the v4 graphql api for everything else. Consequently, you will need to do the following to use the API: 1. Create an OAuth app in the developer settings of your GitHub account 2. Create a keys.dart file in /lib with the following variables: 
    const clientId = 'yourClientId';
const clientSecret = 'yourClientSecret';
    3. Depend on the `github` package from git via `https://github.com/GroovinChip/github.dart` like so:

    github:
  git:
    url: git@github.com:GroovinChip/github.dart.git
  • This application uses wiredash.io for user feedback. As such you will need to create an application there and add your keys to keys.dart like so: 
    const wiredashProjectId = 'yourWiredashProjectId';
const wiredashSecret = 'yourWiredashSecret';
  • This project uses Firebase to handle authentication redirect so you will need to create a Firebase project, follow the instructions to configure Android and iOS projects, and download their respective google-services files.
  • File an issue or comment on an existing issue to report what you will be working to fix or add
  • When you are ready, open a pull request and request review from me, GroovinChip.