| 1 | # express-tomato
|
| 2 |
|
| 3 | An [expressjs][] server and [backbonejs][] client for using the
|
| 4 | [Pomodoro Technique®][pomodoro]. Currently uses [mongodb][] for persistence.
|
| 5 |
|
| 6 | To use as a standalone app, just start up the server:
|
| 7 |
|
| 8 | $ coffee main.coffee
|
| 9 |
|
| 10 | To mount within another express server, run the `.middleware()` method:
|
| 11 |
|
| 12 | app.use('/tomato', require('lmj-tomato').middleware(options))
|
| 13 |
|
| 14 | Available options:
|
| 15 |
|
| 16 | - **analytics** - a Google Analytics identifier
|
| 17 | - **db** - mongodb server to use (defaults to mongodb://localhost/tomato)
|
| 18 | - **timers** - an object with `workSec` and `breakSec` attributes specifying the
|
| 19 | length of the work and break timers (defaults to {workSec: 25 * 60, breakSec:
|
| 20 | 5 * 60})
|
| 21 |
|
| 22 | [expressjs]: http://expressjs.com
|
| 23 | [backbonejs]: http://backbonejs.org
|
| 24 | [pomodoro]: http://www.pomodorotechnique.com
|
| 25 | [mongodb]: http://mongodb.org
|
| 26 |
|
| 27 | ## Inspiration
|
| 28 |
|
| 29 | Initial inspiration came from the lovely http://tomatoi.st/.
|
| 30 |
|
| 31 | The Pomodoro Technique® was developed by Francesco Cirillo and appears to be a
|
| 32 | registered trademark of the same.
|
| 33 |
|
| 34 | ## License
|
| 35 |
|
| 36 | (The MIT License)
|
| 37 |
|
| 38 | Copyright (c) 2011 Leif Johnson <leif@leifjohnson.net>
|
| 39 |
|
| 40 | Permission is hereby granted, free of charge, to any person obtaining a copy of
|
| 41 | this software and associated documentation files (the 'Software'), to deal in
|
| 42 | the Software without restriction, including without limitation the rights to
|
| 43 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
| 44 | the Software, and to permit persons to whom the Software is furnished to do so,
|
| 45 | subject to the following conditions:
|
| 46 |
|
| 47 | The above copyright notice and this permission notice shall be included in all
|
| 48 | copies or substantial portions of the Software.
|
| 49 |
|
| 50 | THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 51 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
| 52 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
| 53 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
| 54 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
| 55 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|