Skip to content

Latest commit

 

History

History
117 lines (75 loc) · 3.59 KB

README.md

File metadata and controls

117 lines (75 loc) · 3.59 KB

Redmine Notifier

Build Status Code Climate Inline docs XO code style License

Redmine Notifier is a simple updated issues checker that runs in the background. It sends a desktop notification if there are any updates in issues.

Installation

Installers for macOS and Windows can be found on the releases page.

For Windows, the app is installed to C:\Users\[UserName]\AppData\Local\redmine\app-[AppVersion]\Redmine Notifier.exe.

Main Notifications

The number of issues that were updated after previous fetch is shown in parentheses. Also, the subject is shown only about the latest issue.

Notification Mac 10.10 Notification Win 10

Sub Notifications

When Redmine Notifier is started, an icon appears in the menu bar or task tray. If there is a notification in the most recent fetch, the icon is replaced by the notification icon.

Menu Icon (macOS)

Normal: Icon Mac Normal Notification: Icon Mac Notification

Tray Icon (Windows)

Normal: Icon Win Normal Notification: Icon Win Notification

Settings

Open the context menu and select "Preferences".

Settings

Development

Redmine Notifier is powered by Electron, so we can develop it with web technologies.

Dependencies

Production
Development

See dependencies and devDependencies in package.json.

Installing dependencies

cd /path/to/redmine-notifier
yarn install

Starting app

yarn start

Building installers

yarn run pack

Linting JavaScript, CSS, and Markdown files

yarn run lint

Testing app

yarn test

See scripts in package.json with regard to other commands.

Contributing

  1. Fork it ( https://github.com/emsk/redmine-notifier/fork )
  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. Create a new Pull Request

Related

  • Redmine Now - A desktop app to know what's happening now on your Redmine

License

MIT