Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/gitify-app/gitify

GitHub notifications on your menu bar. Available on macOS, Windows & Linux.
https://github.com/gitify-app/gitify

electron github github-api gitify node notifications react

Last synced: about 1 month ago
JSON representation

GitHub notifications on your menu bar. Available on macOS, Windows & Linux.

Lists

README

        

# Gitify [![Build Workflow][build-workflow-badge]][github-actions] [![Release Workflow][release-workflow-badge]][github-actions] [![Coveralls][coveralls-badge]][coveralls] [![Renovate enabled][renovate-badge]][renovate] [![Contributors][contributors-badge]][github] [![Downloads - Total][downloads-total-badge]][website] [![Downloads - Latest Release][downloads-latest-badge]][website] [![OSS License][license-badge]][license] [![Latest Release][github-release-badge]][github-releases] [![Homebrew Cask][homebrew-cask-badge]][homebrew-cask]

> GitHub Notifications on your menu bar. Available on macOS, Windows and Linux.

![Gitify](assets/images/press.png)

### Download

You can download Gitify for **free** from the website [www.gitify.io][website] or install it via [Homebrew Cask][brew].

```shell
brew install --cask gitify
```

Gitify supports macOS, Windows and Linux.

### Installation

pnpm install

### Development

Optional: If you prefer to use your own OAuth credentials, you can do so by passing them as environment variables when bundling the app. This is optional as the app has some default "development" keys (use at your own discretion).

OAUTH_CLIENT_ID="123" OAUTH_CLIENT_SECRET="456789" pnpm build

To watch for changes(`webpack`) in the `src` directory:

pnpm watch

To run the **electron app**:

pnpm start

### Releases

The release process is automated. Follow the steps below.

1. Verify that all features you want targeted in the release have been merged to `main`.
2. Create a [new **draft** release][github-new-release]. Set the tag version to something with the format of `v1.2.3`. Save as a **draft** before moving to the next step
3. Create a branch that starts with `release/vX.X.X` (ie. `release/v1.2.3`).
4. In the same branch, **bump the version** of the app by running `pnpm version