FS.TimeTracking

Time tracking for freelancers

Demo

https://demo.timetracking.schick-software.de/

Supported operating systems

Supported operation systems are Windows 10 + / Windows Server 2016 + / Debian based Linux

Other Operating systems might worked but are untested

Supported databases

SQL Server 2019+: Fully tested

MySQL / MariaDB: Fully tested

SQLite: Partially tested, demo runs with it

PostgreSQL: Mainly untested

Installation

Run as docker container

docker run -d -p <port_on_host>:5000 \
	--name timetracking \
	-e TimeTracking__Database__Type='<MySql|SqlServer|Sqlite|PostgreSql>' \
	-e TimeTracking__Database__ConnectionString=<connection string> \
	schicksoftware/timetracking

Run from command line

# Windows
.\FS.TimeTracking.exe

# Linux
chmod +x ./FS.TimeTracking
./FS.TimeTracking

Install as Windows service

# Copy the content of publish folder to suitable location
mkdir C:\services\TimeTracking
robocopy /E timetracking.1.0.1.windows\ C:\Services\TimeTracking

# When the service runs from program folder adjust path to log files (programm folder isn't writeable!)
cd C:\services\TimeTracking
notepad config\FS.TimeTracking.config.nlog

# Install and run as windows service
# The service will be installed as "FS.TimeTracking". You can change the name in the .bat file
C:\services\TimeTracking\services\windows.service.install.bat

# Uninstall service
C:\services\TimeTracking\windows.service.uninstall.bat

Install as Linux daemon

# Copy files
cp -r timetracking.1.0.1.linux/opt/FS.TimeTracking/ /opt/
cp timetracking.1.0.1.linux/etc/systemd/system/FS.TimeTracking.service /etc/systemd/system
chmod +x /opt/FS.TimeTracking/bin/FS.TimeTracking

# Create system user/group
useradd -m dotnetuser --user-group
# Adjust user/group
vi /etc/systemd/system/FS.TimeTracking.service
chown -R dotnetuser:dotnetuser /opt/FS.TimeTracking/
chmod -R o= /opt/FS.TimeTracking/

# Test service
/opt/FS.TimeTracking/bin/FS.TimeTracking

# Start service
systemctl daemon-reload
systemctl start FS.TimeTracking.service

# Get service status
systemctl status FS.TimeTracking.service
journalctl -u FS.TimeTracking.service

# If you want your service to start when the machine does then you can use
systemctl enable FS.TimeTracking.service

Configuration

Application / Service / Kestrel configuration

./config/FS.TimeTracking.config.json

"TimeTracking": {
  "Features": {
    // Enable authorization
    "Authorization": false,
    // Enable reporting
    "Reporting": false
  },
  "Database": {
    "Type": "Sqlite",
    "ConnectionString": "Data Source=database/TimeTracking.sqlite"

    //"Type": "SqlServer",
    //"ConnectionString": "Data Source=<server>;Initial Catalog=<database>;User ID=<user>;Password=<password>;Persist Security Info=True;TrustServerCertificate=True"

    //"Type": "PostgreSql",
    //"ConnectionString": "Server=<server>;Database=<database>;User Id=<user>;Password=<password>;"

    //"Type": "MySql",
    //"ConnectionString": "Server=<server>;Database=<database>;User=<user>;Password=<password>;"
  },
  "Reporting": {
    // The base URL of the report server
    "ReportServerBaseUrl": "http://localhost:5010"
  },
  "Keycloak": {
    // The URL of the Keycloak server
    "AuthServerUrl": "https://URL/to/Keykloak",
    // The realm to use
    "Realm": "<Realm>",
    // The client id of the backend application
    "ClientId": "<Front-end client id>",
    "SslRequired": true,
    "VerifyTokenAudience": true,
    // Creates the realm if it does not exist
    "CreateRealm": false,
    // The username of the admin user to create the realm, clients and users
    "AdminUser": null,
    // The password of the admin user to create the realm, clients and users
    "AdminPassword": null
  }
}

Logging configuration

./config/FS.TimeTracking.config.nlog

See official documentation for details

Features

Reports

Activity reports available via TimeTracking Report Server. The server uses a paid reporting engine. Let me know if you know of a suitable free report engine. Contact me, if you like to go with the paid reporting engine.

User management

Authentication is available via OpenID Connect / OAuth2 with Keycloak. Other identity servers may work with smaller adjustments or limitations (e.g. users and role must be created by your own).

Development

Pre requirements

.NET 7 SDK

Node.js 16.x

OpenJDK (required to generate Angular REST client via OpenAPI Generator)

Run

Download or clone repository

git clone https://github.com/fschick/TimeTracking.git
cd TimeTracking

Install NPM packages

cd FS.TimeTracking.UI/FS.TimeTracking.UI.Angular
npm install
cd ../..

Run server

dotnet run --project FS.TimeTracking/FS.TimeTracking/FS.TimeTracking.csproj

Run UI

cd FS.TimeTracking.UI/FS.TimeTracking.UI.Angular
npm run start

Open web browser:

http://localhost:4200/

Publish

See publish script Build/make_publish.ps1