Code Monkey home page Code Monkey logo

gitify's Introduction

Gitify github coveralls downloads

GitHub Notifications on your menu bar. Available on macOS, Windows and Linux. Gitify Mobile has been deprecated in favour of the official GitHub mobile app.

Gitify

Download

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

brew install --cask gitify

Gitify supports macOS, Windows and Linux.

Prerequisites & Libraries

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. Create a new draft release. Set the tag version to something with the format of v1.2.3. Save as a draft.
  2. Once everything is merged to main, create a branch that starts with release/vX.X.X (ie. release/v1.2.3).
  3. In the same branch, bump the version of the app in the package.json file and open a PR. GitHub Actions will build, sign and upload the release assets for each commit to that branch as long as a branch is named like release/vX.X.X and there is a draft release with the same version number(package.json).
  4. Merge your release branch into main.
  5. Publish the draft release once you've added notes to it and all assets are there.

Tests

There are 2 checks - one for prettier and one for the unit tests with jest.

    // Run prettier to check
    pnpm prettier:check

    // Run linter & unit tests with coverage
    pnpm test

    // If you want to pass arguments to jest (or other `pnpm` commands) 
    // like `--watch`, you can prepend `--` to the command
    pnpm test -- --watch

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?

You can debug Gitify by pressing alt + command + I. This will open the dev tools 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.

gitify's People

Contributors

manosim avatar ekonstantinidis avatar jakesidsmith avatar mrmlnc avatar codebytere avatar deibeljc avatar afonsojramos avatar renovate[bot] avatar brandonweiss avatar sergiopvilar avatar yyar avatar richrace avatar iansu avatar kawarimidoll avatar rhysd avatar azu avatar happytobi avatar timmikeladze avatar simonsmith avatar philihp avatar maks-rafalko avatar luflosi avatar juice805 avatar jasonbarry avatar dijonkitchen avatar hughlilly avatar araxeus avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.