Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sargsyan/github-notifier
Get Github and Github Enterprise notifications in your Mac OS https://githubnotifier.net
https://github.com/sargsyan/github-notifier
github github-enterprise github-notifications macosx notifications productivity service
Last synced: 2 months ago
JSON representation
Get Github and Github Enterprise notifications in your Mac OS https://githubnotifier.net
- Host: GitHub
- URL: https://github.com/sargsyan/github-notifier
- Owner: sargsyan
- License: mit
- Created: 2018-06-03T10:42:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-09T21:38:11.000Z (over 4 years ago)
- Last Synced: 2024-08-09T13:17:35.062Z (6 months ago)
- Topics: github, github-enterprise, github-notifications, macosx, notifications, productivity, service
- Language: Shell
- Homepage:
- Size: 11.4 MB
- Stars: 35
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-notifier
## Summary:
Real-time notifications from github and github enterprise instances in your desktop.
Supported for OS X Yosemite and newer versions
## Instructions for installation and usage
```sh
brew install sargsyan/github-notifier/github-notifier && github-notifier-install
```
Add more Github enterprise instances or change configurations with
```sh
github-notifier-configure
```
More information on installation is on https://githubnotifier.net/#install
If you like the application, please ★ the repo
## Instructions for playing with source code
### Prerequisites
Make sure that you have **jq** command installed. **jq** is needed to github API response parsing.
### Installation
To install the application run
```sh
make install
```
It will post files needed to scheduled run into /Library/LaunchDaemons files of MacOS.
If you want to revert the actions of install then run
```sh
make uninstall
```
### Configurations
The application is designed to run for multiple github instances on the same time.One instance is github.com the others are github enterprise instances.
Generally you will need to have one or two configurations. You can list, create, remove, activate and deactivate configurations. to get the help for configure.sh just run.
```sh
./configure.sh
````
### Testing
If something is not working in your system and you are sure that configurations are correct you can run unit tests for your system to see if system behaves correctly. For this you need to install test framework shell scripts and run unit tests locally
```sh
brew install shunit2
make test
```
### Troubleshooting
To check the daemon logs for the error, use
```sh
tail -f /var/log/system.log
```
If the system logs tell that the application keeps exiting with non-zero exit codes, use
```sh
cat ~/Library/Logs/github_notif/service.log
```
Or locate github_notif folder in the Mac [Console application](https://support.apple.com/guide/console/welcome/mac).
Advanced users can change the source code on the installed package. For example, to change the code of the main script open the following files
```sh
ls /usr/local/Cellar/github-notifier/ #To get the current version
vi /usr/local/Cellar/github-notifier//lib/github_notif
```