Skip to content
GitHub notifications on your menu bar.
TypeScript JavaScript HTML
Branch: master
Clone or download
manosim Setup Release GitHub Action (#376)
* Setup release workflow

* Pass GH Token & publish with onTagOrDraft
Latest commit b172e8e Feb 13, 2020

README.md

Gitify github codecov downloads

The mobile app has been deprecated in favor of the official GitHub mobile app the is coming out soon.

Gitify

Download

You can download Gitify for free from either the website www.gitify.io or from the GitHub repository releases page.

You can also install Gitify via Homebrew Cask

brew cask install gitify

Gitify currently only supports mac OS.

Prerequisites

Installation

yarn install

Development

First you will need to set the testing CLIENT_ID and CLIENT_SECRET in src/js/utils/constants.js file. You can use the development app credentials (use at your own discretion):

Client Id: 3fef4433a29c6ad8f22c
Client Secret Key: 9670de733096c15322183ff17ed0fc8704050379

To watch for changes in the src directory:

yarn run watch

To run the actual electron app:

yarn start

Distribution

To prepare the app for distribution run:

yarn run build
yarn run pack
yarn run make:macos

Tests

There are 2 linters for js & scss and unit tests with jest.

// Run only unit tests
yarn run jest

// Run linter & unit tests with coverage
yarn run test

FAQ

My notifications aren't showing?

Some organisations require applications to request access before allowing access to any data (including notifications) about their repositories.

To check if Gitify is approved by your organisation you can go to https://github.com/settings/applications, then click on Gitify and scroll to Organization access.

Something looks wrong - How can I debug?

Since version 1.1.0 you can now debug Gitify by pressing alt+cmd+I. This will open the devtools and then you can see any logs, network requests etc.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request
  6. Make sure tests are passing

License

Gitify is licensed under the MIT Open Source license. For more information, see the LICENSE file in this repository.

You can’t perform that action at this time.