Skip to content

Latest commit

 

History

History
19 lines (12 loc) · 1.54 KB

README.md

File metadata and controls

19 lines (12 loc) · 1.54 KB

App

A simple Github Organisation subscription app that makes calls to the github api and stores the data in firebase. Optimised and built for mobile. Save to homescreen to get native-like feel.

Getting started

The app is deployed at: https://beppek-github-webhooks.firebaseapp.com

Start by logging in with your Github account. Next find an organisation where you are admin and create a hook. Alternatively find an organisation where admin has already created a hook within the app.

You can now select which events will trigger notifications for each organisation. At the moment the possible events are: Pull Request, Push, Release, Watch, Wiki Event (gollum), Issues and Fork.

Your events will show up in the home page's feed.

Service worker

The app uses a service worker and will ask for permission to push notifications in the browser. To get push notifications when you are not in the app you will need to accept. The service worker will cache the static files but can not cache the content requested from Firebase or Github.

Project status

The app is functional. Extensive testing is still needed as limited resources has held the testing back. More users are needed to fully test the functionality of the app. Development was rushed towards the end leaving a few console logs and most importantly a not completely finished serive worker controller. Left to do in regards to service worker is to handle update to the page or service worker and prompt user to reload the page.

Next iteration would allow users to view events on a per organisation basis.