Code Monkey home page Code Monkey logo

potato's Introduction

Potato Clock - Browser Extension

Node CI

Potato Clock is a modified web extension from Tomato Clock. Potato Clock is a simple browser extension for managing your productivity. Use the extension to break down your work into 25 minute 'Potato' intervals separated by short breaks. Use the long break after completing four Potato intervals.

Features:

  • Customizable timer lengths
  • Browser notifications
  • Stat tracking
  • Multiple options of notification sounds
  • Automatically start break time

You can customize the length of the Potatoes and breaks in the extension page. The extension uses the default browser notification system, accompanied by a sound, to let you know when the timer is over. The extension also features stats for tracking how many Potatoes you complete. Your stats are synced across devices using the browser's cloud storage support.

Due to a trademark complaint, the extension was renamed from Pomodoro Clock to Potato Clock.

Please file any issues or feature requests at https://github.com/samueljun/tomato-clock/issues.

Installation

Development

  1. Install node.js and npm.

  2. Install the required node modules:

npm install
  1. Run the following command so that webpack can watch and recompile the /src files live to the /dist folder:
npm run watch

Firefox

To run the extension with live reloading in a clean Firefox instance, run the following command in a separate terminal:

npm run watch-firefox

To temporarily load the extension in a normal Firefox instance:

  1. Go to about:debugging
  2. Click Load Temporary Add-on
  3. Load the src folder

Chromium

  1. Go to chrome://extensions/
  2. Enable developer mode
  3. Click Load unpacked extension...
  4. Load the /dist folder

Updating the version number

Run the following command with the appropriate npm version {patch/minor/major} to bump the package.json version based on semver:

npm version patch && git push && git push --tags

Building submission file

Run the following command so that webpack can recompile the /src files in production mode to the /dist folder:

npm run build

States export json format

The expected formatting of Potato Clock's .json files is as follows

[
  { "timeout": 1500000, "type": "potato", "date": "2020-08-29T18:07:55.895Z" },
  { "timeout": 300000, "type": "shortBreak", "date": "2022-04-13T04:13:37.406Z" },
  { "timeout": 900000, "type": "longBreak", "date": "2022-04-13T04:13:40.030Z" },
  { "timeout": 1500000, "type": "potato", "date": "2022-04-13T04:13:45.182Z" }
]
  • At the base, there is an array [] of objects {}
  • Each object {} is an instance of the clock timer.
  • Within each object:
    • "timeout": is the time in milliseconds of the timer
    • "type": is one of "potato", "shortBreak", or "longBreak"
    • "date": is the exact date and time string in the ISOString format

potato's People

Contributors

samueljun avatar dependabot[bot] avatar chyeoh3012 avatar gliptak avatar zabrador avatar ihoudjedje avatar davebrothers avatar eprikazc avatar gitoffthelawn avatar

Stargazers

 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.