README.md

WorkTimer

Time tracking app built with Remix, supports authentication, projects management, and monthly or custom reports.

Built for self-hosting: host it anywhere you want, and use it for free. Your time, your data.

View on DockerHub.

Table of contents

• Features
• Pre-built Docker image
  • Docker compose
• Custom deployments or development
  • Tech stack
  • Running locally
  • Running with Docker
  • Multi-platform docker image
• Screenshots
• License

Features

• Time entries management
• Authentication
• Multi-user support, with admin role
• Projects management
• Monthly or custom reports
• Import/Export to CSV

Screenshots

Pre-built Docker Image

docker pull nzambello/work-timer

If you want to use the pre-built Docker image, you can run it with:

docker run -d -p 8080:8080 -v /path/to/data:/data/data.db nzambello/work-timer

If you want to use different defaults, you can build your own image. See Running with docker

Docker compose

Basic example:

version: '3.8'

services:
  work-timer:
    image: nzambello/work-timer
    container_name: work-timer
    restart: always
    ports:
      - 8080:8080
    volumes:
      - ./dockerData/work-timer:/data # Path to data for DB persistence

Example of docker-compose.yml with Traefik as reverse proxy:

work-timer:
  depends_on:
    - watchtower
  image: nzambello/work-timer
  container_name: work-timer
  restart: always
  volumes:
    - /dockerData/work-timer:/data # Path to data for DB persistence
  labels:
    - 'com.centurylinklabs.watchtower.enable=true'
    - 'traefik.enable=true'
    - 'traefik.http.routers.work-timer.rule=Host(`timer.YOURDOMAIN.com`)'
    - 'traefik.http.routers.work-timer.entrypoints=websecure'
    - 'traefik.http.routers.work-timer.tls.certresolver=letsencrypt'
    - 'traefik.http.routers.work-timer.service=work-timer-service'
    - 'traefik.http.services.work-timer-service.loadbalancer.server.port=8080'

Custom deployment or development

Tech Stack

• Remix
• Prisma
• SQLite
• Mantine
• Docker

Running Locally

# Clone the repo
git clone https://github.com/nzambello/work-timer.git
cd work-timer

# Install dependencies
yarn install

# Setup .env
cp .env.example .env
vim .env

# Start the app
yarn dev

Running with Docker

# Clone the repo
git clone https://github.com/nzambello/work-timer.git
cd work-timer

# Setup .env
cp .env.example .env
vim .env

# Build the image
docker built -t work-timer .

# Start the app
docker run -p 127.0.0.1:8080:8080 work-timer

Multi-platform Docker image

docker buildx create --name mybuilder --driver docker-container --bootstrap --use # create a new builder and switch to it using a single command.
docker buildx build --platform linux/amd64,linux/arm64 -t nzambello/work-timer:latest --push .

Screenshots

Light / Dark mode

Time tracking

Projects

Reports

License

Nicola Zambello © 2023

GNU GPLv3