Repository files navigation

A cross-platform mob-timer built onElectronfor doingMob Programming. This is a fork frompluralsight/mob-timer.

Click the gear icon in the top right to configure the mob-timer.Then click the large circle to start/stop the mob-timer,or the smaller circle to skip to the next mobber.

You can either build the mob-timer from source ordownload a pre-built version.

Prerequisites:Node.js with the version specified in.nvmrc, installed either manually or by usingnvm/nvm-windows

Runnpm ci and then one of the following commands for your respective operating system:

• Windows:npm run build-win
• Mac OS X:npm run build-mac
• Linux:npm run build-linux (You may need to installlibcanberra-gtk-module)

Platform specific packages will be placed in thedist directory.If you need a platform other than these, you will need to modify the build script in thepackage.json file.

Runnpm ci to get the dependencies, thennpm start to run the timer.Runnpm test to run the unit tests once, or alternativelynpm run watch to run them on changes.More information on test structure.

Feel free to open Issues and Pull Requests discussing additions to this project. You can also have a look at theexisting issues. Keep the Pull Requests small and make sure the tests and code style checks pass.

If you are uncertain, please reach out first (by opening an issue) before investing too much time. :)

This is a fork frompluralsight/mob-timer, please have a look to see if that project is more suited to your needs! 🙂

There are a few main reasons for this fork existing:

• To build in CI and attach to release usingTravis CI
• To move to code style and tooling suited for project, not needing to take internal company best practices into account
• To have an independent organization where the mob-timer is the focus

The Mob Timer is licensed under theApache 2.0 license.