the quick time and budget tracking tool
PHP CSS JavaScript Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
config
plugins
src
tests
webroot
.editorconfig
.gitattributes
.gitignore
.htaccess
.travis.yml
README.md
TODO.md
composer.json
composer.lock
dbConvert.php
index.php
phpunit.xml.dist

README.md

TDTrac is a web based show budget and payroll hours tracker, built by a TD, for other TD's, freelance designers, and anyone else who finds it useful. TDTrac is completely free, released as open source.

TDTrac Features:

  • Track as many show budgets as you wish
  • Budgets can be organized by vendor, category, or even amount spent
  • Track as many active or inactive employees as you wish
  • Configurable pay rate for budgeting purposes
  • Allow your employees to add thier own hours, while being notified on your next login
  • Optionally allow your employees to add budget expenses, or even view the current budget
  • Manage tasks lists on a per-show basis.
  • Manage a per-show calendar of events.
  • Send periodic e-mails to your users, reminding them to input their hours.
  • Send periodic reports to yourself or your payroll department for processing.
  • Send daily event lists to your users or yourself from a show calendar.
  • Send a task list reminder to your users or yourself, per-show.

TDTracX

This is the new version of TDTrac, completely refactored in CakePHP3.

LICENSE:

You may use this code, in part or in full, for any reason, in any circumstance without notifying the author. You may redistribute this code, in full or part, with any project you work on. If you wish to charge for this code as part of your project, you may. You may not sell this code without modification, but you may charge for installation or use of this code on your own server. If you find this especially useful, or make a ton of money off this though, please drop me a line as I would love to see what you have put together. Also, if you use this code as a basis of a new project, I would also like to see what you come up with.

Installation

1.) Clone GIT repository into your hosting folder, and change into that directory.

2.) Run composer:

$ composer install

3.) Edit the configuration file in config/ - Copy tdtrac.php-dist to tdtrac.php and edit the new file.

4.) Run initial migration (this creates the empty database):

$ ./bin/cake migrations migrate

5.) Run TDTracX installer (this creates the initial user, and sets up the datebase proceedures):

$ ./bin/cake tdtrac install

6.) Log in, change user e-mail, name, and password.

Lighttpd Redirects:

$HTTP["host"] =~ "demox\.tdtrac\.com" {
    server.document-root = "/full/path/to/TDTracX/webroot/"
    url.rewrite-if-not-file =(
        "^([^\?]*)(\?(.+))?$" => "/index.php?url=$1&$3"
    )
}

Improve performance?

$ php composer.phar dumpautoload -o

The Demo

If you want to run your own version of the demo, you can run the shell script. (This is totally destructive to the PRODUCTION database - you have been warned.)

To run it, you will need to be able to read and understand the php file, located at:

$ ./bin/cake tdtrac demoreset

Other Console Commands

$ ./bin/cake tdtrac [command]
  • adduser - Add's a user.
  • ban - Ban a user.
  • unban - Un-Ban a user.
  • resetpass - Reset a user password.

All of these things can be done in the app itself, however, if for some reason you don't wish to maintain an admin account of your own, you could use this. Also great if you forget your admin password.

Periodic Emails

Newly added to the web interface, you can send periodic e-mails, either to remind users to input hours, or to send the unpaid hours to the payroll department. You will need to alter 2 settings to make this work. In config/tdtracx.php set "ServerTimeZoneFix" to your server's timezone. It's how the offset it fixed. This is important, or things won't run quite when you expect.

Next, add a line to cron:

0 */2 * * * /home/tdtrac/bin/cake tdtrac cron

This should really be in the web server user's crontab. Please, don't run it as root. Or any other user that does not own the cakephp install directory really. Bad things will happen. It'll overwrite the cache files and break your install until you fix them manually.

This will allow tasks to run once every other hour. Tasks will run as soon as possible after their set schedule. As there is some imprecision with cron, tasks will not run exactly at thier scheduled time. You can improve this resolution by running tdtrac cron more often, but if you do it enough, there will be performance concerns.

See the web interface under "scheduled tasks" for what these cron tasks can be.