Coder Social home page Coder Social logo

pquentin / pomodorock Goto Github PK

View Code? Open in Web Editor NEW

This project forked from brunobord/pomodorock

0.0 3.0 0.0 802 KB

A single webpage pomodoro timer / tracker that keeps ZERO KNOWLEDGE of your data on the server-side.

Home Page: http://brunobord.github.io/pomodorock

License: Do What The F*ck You Want To Public License

JavaScript 97.88% CSS 2.12%

pomodorock's Introduction

Pomodorock

A single webpage pomodoro timer / tracker that keeps ZERO KNOWLEDGE of your data on the server-side.

License

Pomodorock is distributed under the terms of the WTFPL. See the LICENSE file for more details. But basically, it's almost a Public Domain thing.

Requirements

  • A modern HTML5-capable browser (canvas, localStorage, API etc.)
  • Optional: A web server

Usage

Install options

  • Browse http://brunobord.github.io/pomodorock/,
  • OR Put these files on a web server where you can access the "index.html",
  • OR Fork the project and host it on your own github pages: http://username.github.io/pomodorock

The built-in JS server

You can also install Node.js and use the basic server included with this project. It is a dead simple Express app listening to on port 27000.

Install and enjoy:

npm install && node server.js
open http://localhost:27000

Python SimpleHTTPServer

Python is awesome โ™ก.

You can serve this app in a single one command:

python -m SimpleHTTPServer 27000

(Of course, you can change the port to suit your needs).

Use

Follow the Pomodoro Technique.

  • Start your Pomodoro timer.
  • Work for 25 mn.
  • Increment your Pomodoro daily counter.
  • Have a short break (5 mn).
  • Each time somebody or something interrupts you, increment the interruption counter.
  • Every 3 to 4 Pomodoro cycle, have a longer break. Go outside, do something else.
  • Rinse, repeat.

With days of pomodoro logging, you'll see the tiny sparkline graph tracking your Pomodoro count.

Under the hood

I'm not storing anything, I promise.

Everything, I mean EVERYTHING you put in this tracker is stored locally in your browser localStorage database. Don't worry about your privacy, it's safe.

Caution

Don't mess with the keys/values

You can inspect the localStorage keys and values, but please don't mess with it or you may lose data. This program is using BankersBox module to store counters. Any manual operation on it may break something.

Changing location

The localStorage database is linked to the page URL / Domain. If you're moving the index file and static resources, it will reset your stats down to zero. Well, your "old" stats are not gone, they're just still linked to your browser profile and URL. Simply browsing the old URL will help you find it out again.

Just backup on the former location before moving to the new one.

Changing browser / computer

Switching from a browser to another is equivalent to changing this page location. Not the same profile -> no data. And going from a computer to another will result the same.

Just backup on the former computer before moving to the new one.

Let me help you

We now have a Database Backup/Restore feature. The whole localStorage database can be saved as a simple string of text, and restore.

SERIOUS WARNING: Carefully follow the given instructions, or your backup may be severly damaged. You MUST be sure that your copy-paste operation has kept the backup intact.


Uses and abuses

pomodorock's People

Contributors

brunobord avatar gillesfabio avatar pquentin avatar

Watchers

 avatar James Cloos avatar  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.