New project: BoredTODO

Posted February 16th, 2011 in Projects by Metod

I managed to find some free time and finish my quick project – BoredTODO. It is essentially a TODO list which you can use when you get bored, so you have something to do. It takes advantage of some libraries and services:

Some facts:

Doctrine2 DBAL is a database abstraction layer, which makes it easy to work with the database on a smaller projects like this.

It is written in PHP 5.3.

jQuery was used to make all the shortcuts and ajaxy stuff work.

Reset CSS is in my opinion a must tool for every project, since it gives you a nice clean foundation to style on.

Google Fonts API was used for making the Ubuntu font family available in CSS across platforms and browsers.

The app is HTML5, just for fun.

It uses some CSS3 features for making rounded borders and gradients without pictures work. Therefore only few browsers are supported. Of course IE is not one of them.

You can see and try out the demo here

or

You can grab the source code on GitHub.

Requirements

PHP >= 5.3.0

Tested on UNIX system. Not tested on Windows.

Installation

In config/config.php change $connectionParams to your configuration.

  1. $connectionParams = array(
  2.     "dbname"   => "CHANGEME",
  3.     "user"     => "CHANGEME",
  4.     "password" => "CHANGEME",
  5.     "host"     => "localhost",
  6.     "driver"   => "pdo_mysql"
  7. );

and also change the basedomain configuration value.

  1. Config::$basedomain = "http://CHANGEME";

Usage

BoredTODO is all about keyboard shortcuts.

First off you will want to type in a short description of the task at the top. If you wish to add this task without any longer descriptions, press ENTER and the task is inserted.

BoredTODO offers you three priorities – low, medium and high. If you wish to add a priority to your TODO, type one of the keywords “low”, “med” or “high” followed by a whitespace in the short description. Examples:

  • low This is a task with low priority.
  • med This is a task with medium priority.
  • high This is a task with high priority.

But if you would like to add some detailed description to the task, press TAB and the cursor will be focued on a textarea in which you can type the description.

For insertion of the task press TAB again.

Your TODO is ready for usage.

If there is a long description, a pointer cursor will appear when you hover over a TODO item. If you click on it, the description will show up. If you click on it again, it will disappear.

When you want to close the task, you have to click on the most-left side of the TODO – the priority color. When you do that, the TODO is checked (deleted). But if you made a mistake, you can easily undo the action by clicking on the priority color again. The TODO is back.

Browser Support

Since BoredTODO uses some CSS3 features it supports only the latest and non-IE browsers:

  • Firefox
  • Chrome

Untested:

  • IE9
  • Safari

Opera 11 does not seem to have support for CSS gradients, so it is not fully supported. BoredTODO might function on other browsers as well, but was not tested.

Code License

MIT License

Copyright © Metod

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.