Skip to content

A cross-platform mob-timer built on Electron for doing Mob Programming.

License

Notifications You must be signed in to change notification settings

mob-timer/mob-timer

 
 

Repository files navigation

Mob Timer

GitHub release License GitHub contributors Travis (.org) Coverage Status GitHub All Releases GitHub open idea issues

A cross-platform mob-timer built on Electron for doing Mob Programming. This is a fork from pluralsight/mob-timer.

Example Timer Image

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.

Running the mob-timer

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

Build mob-timer

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

Run npm 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 install libcanberra-gtk-module)

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

Development

Run npm ci to get the dependencies, then npm start to run the timer. Run npm test to run the unit tests once, or alternatively npm run watch to run them on changes. More information on test structure.

Contributing

Feel free to open Issues and Pull Requests discussing additions to this project. You can also have a look at the existing 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. :)

Reasons for forking

This is a fork from pluralsight/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 using Travis 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

License

The Mob Timer is licensed under the Apache 2.0 license.

About

A cross-platform mob-timer built on Electron for doing Mob Programming.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 87.2%
  • CSS 6.9%
  • HTML 5.9%