Skip to content

bountin/ttrack

Repository files navigation

TTrack

Build Status

A Time Tracking application. Needs a Postgres Database.

Getting Stated

Dependencies

First you need a postgres Database with at least version 9.3.

For manual installation you also need npm and the npm package db-migrate:

$ npm install -g db-migrate

Manual Install

Then you need the two config files from config:

cp config.json.example config.json 
cp database.json.example database.json

Adjust the config to your setup and then you need to install the database migrations using:

db-migrate up

To start the server you need the node environment NODE_ENV setup to production. Then call npm to start the server:

npm start

Docker Variant

TODO: need documentation how to start the docker version.

Administration

To setup the users you need to be comfortable using the psql shell and working with the database as there is no Administration Interface, everything is done using pure sql. The user table is your main starting point.

Also the austrian holdiays are kind of hardcoded.

Development

This section explains how to develop the TTrack application.

Getting Started

To start developing you have to run the app in dev mode. Prefer to do this locally which will be more efficient.

# don't forget migrations!
$ db-migrate up

# start the ttrack server (port 8080)
$ npm start

# start the webpack dev server
$ npm run dev

# open the app
$ open http://localhost:8080

The webpack dev server watches the sources and serves the built JS and CSS with hot reloading enabled. The ttrack server serves the main index.html and the rest API. It requests JS and CSS from the webpack dev server.

Contributors

Since because of security concerns we needed to purge the git commit history, here are the contributors of the project.

History

It all started as a fun project and never majored of it. It is strictly a tool for tracking our times with our needs. (f.e. Austrian Holidays, no Administration, ...)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published