Skip to content

funnyleolee/gitify

 
 

Repository files navigation

Gitify

travis codecov slack

Gitify

Roadmap Version 1.0.0

It has been a while since this app was made so I decided to give it a good revamp and hit 1.0.0. This will bring the app up to date and prepare it for the future. So below you can find all the changes coming up to Version 1.0.0. From the normal user's point of view, nothing will break. People contributing, will probably want to have a look to the list below. Once we are done with this list(if not at the same time), I think it will be time to distribute the app to Linux & Windows.

  • Update all (dev)dependendencies - Things tend to evolve fast in the js commumity.
  • Update Electron - Electron gets better and better in every release.
  • From Browserify to Webpack - In the future we can have Hot Module Replacement!
  • React 15.0+ - Major React Update.
  • Use ES6 - Because ES6!
  • Move from Reflux to Redux - I've spent some time rewriting gitify to redux. It's just amazing.
  • Update Bootstrap to version 4 - Which means move from LESS to SCSS.
  • Rewrite tests with Mocha - Since gitify is moving from Reflux to Redux, all tests have to be rewritten.
  • Move to Codecov for coverage with new tests
  • Rebranding - New Logo! Fresh stuff!
  • Revamp the UI. From Scratch?

If you would like to help let me know! There is a slack channel for gitify in the atom team. See badge on the header.

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 OS X.

Prerequisites

Installation

npm 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:

npm run watch

To run the actual electron app:

npm start

Distribution

To prepare the app for distribution run:

npm run package

To publish a new version, you also need to codesign the app running npm run codesign. Currently supports only OS X.

Tests

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

// Run all tests
npm run test

// Run only unit tests
npm run mocha

// Run unit tests with coverage
npm run coverage

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.

About

GitHub Notifications on your menu bar.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 92.3%
  • CSS 7.2%
  • Other 0.5%