Skip to content

README.md

Latest commit

 

History

History
223 lines (155 loc) · 14 KB

README.md

File metadata and controls

223 lines (155 loc) · 14 KB

api build frontend build android build mcp build codecov CodeQL Dependabot Updates

Task Wizard

Privacy First, Productivity Always!

Task Wizard is a free and open-source app designed to help manage tasks effectively. Its primary focus is to give users control over data and allow them to build integrations around it however they choose to.

This repo started as a fork of DoneTick but has since diverged from the original source code in order to accomplish different goals. Kudos to the contributors of DoneTick for helping kickstart this project.

🎯 Goals and principles

Task Wizard's primary goal is to allow users to own and protect their data and the following principles are ways to accomplish that:

  • Zero PII storage — the server never stores names, emails, or any personally identifiable information. Authentication is handled entirely by Microsoft Entra ID; the backend only persists an opaque directory/object ID pair to associate tasks with a user
  • All the user data sent by this frontend only ever goes to a single backend
  • 🔜 When data is stored, it is encrypted with a user key
  • The code is continuously scanned by a CI that runs CodeQL
  • Dependencies are kept to a minimum
  • When vulnerabilities are detected in dependencies they are auto updated with Dependabot

✨ Features

✅ Fast and simple task creation and completion for those times you are in a hurry

🏷️ Label assignment to help you categorize and recall tasks efficiently

📅 Due and completion dates tracking for users who need historical records

🔁 Recurring patterns for those chores you don't want to forget

📧 Notifications for important deadlines you don't want to miss

📱 Native Android app with real-time sync

⌨️ Keyboard Shortcuts

Context/Screen Shortcut Action or Result
Tasks Overview Ctrl + F Focuses the search box.
Tasks Overview + (outside of inputs) Opens the “Add Task” screen.
Task Edit and Date modals Enter in text or date fields Submits or saves the form or dialog.

🔐 Authentication

Task Wizard uses Microsoft Entra ID (Azure AD) for user authentication. Users sign in via a popup flow using MSAL, and the backend verifies tokens using OIDC.

To set up authentication:

  1. Register an application in your Azure AD tenant
  2. Configure entra.tenant_id, entra.client_id, and entra.audience in config.yaml (or via TW_ENTRA_* environment variables)
  3. Set entra.enabled to true

For development without Azure AD, set entra.enabled to false to enable dev bypass mode (all requests are treated as authenticated).

🚀 Installation

🚢 Using Docker Compose (recommended)

  1. In a compose.yml file, paste the following:
services:
   tasks:
      image: dkhalife/task-wizard
      container_name: tasks
      restart: unless-stopped
      ports:
      - 2021:2021
      volumes:
      - /path/to/host/config:/config
  1. Run the app with docker compose up -d

Alternatively, you can use a .env file and reference it in the compose file using an env_file entry.

🛳️ Using Docker

  1. Pull the latest image: docker pull dkhalife/task-wizard
  2. Run the container:
docker run \
   -v /path/to/host/config:/config
   -p 2021:2021 \
   dkhalife/task-wizard

Make sure to replace /path/to/host with your preferred root directory for config.

⚙️ Configuration

In the config directory are a couple of starter configuration files for prod and dev environments. The server expects a config.yaml in the config directory and will load settings from it when started.

Note: You can set Entra ID settings and database credentials using environment variables for improved security and flexibility.

Telemetry (Application Insights)

Task Wizard supports optional Application Insights telemetry for both the API server and Android app. All events are sent as CustomEvents and include build number, commit hash, and component identifiers.

API Server: Set the APPINSIGHTS_CONNECTION_STRING environment variable. When not set, telemetry is silently disabled.

Android App: Telemetry is disabled by default. Users can opt in via Settings → Analytics. When disabled, the app sends a DNT: 1 header on all API requests, which the backend respects by skipping request telemetry for that user. An additional "Debug logging" sub-toggle sends more detailed diagnostic data when enabled.

Database Configuration

Task Wizard supports both SQLite and MySQL databases. By default, it uses SQLite.

SQLite (default)

To use SQLite, set database.type to sqlite (or leave it unset) in your config.yaml:

database:
  type: sqlite
  path: /config/task-wizard.db
  migration: true

MySQL

To use MySQL, configure the database section:

database:
  type: mysql
  host: localhost
  port: 3306
  database: taskwizard
  username: taskuser
  password: taskpass
  migration: true

You can also use environment variables for database configuration:

  • TW_DATABASE_TYPE - Database type (sqlite or mysql)
  • TW_DATABASE_HOST - Database host
  • TW_DATABASE_PORT - Database port
  • TW_DATABASE_NAME - Database name
  • TW_DATABASE_USERNAME - Database username
  • TW_DATABASE_PASSWORD - Database password

Authentication Configuration

Configure Entra ID authentication with environment variables or config.yaml:

  • TW_ENTRA_ENABLED - Enable Entra ID authentication (true/false)
  • TW_ENTRA_TENANT_ID - Azure AD tenant ID
  • TW_ENTRA_CLIENT_ID - Azure AD application (client) ID
  • TW_ENTRA_AUDIENCE - Expected token audience

Configuration Reference

The configuration files are yaml mappings with the following values:

Configuration Entry Default Value Description
name "prod" The name of the environment configuration.
database.type sqlite Database type: sqlite or mysql.
database.migration true Indicates if database migration should be performed.
database.path /config/task-wizard.db The path at which to store the SQLite database (SQLite only).
database.host (empty) Database host (MySQL only).
database.port 3306 Database port (MySQL only).
database.database (empty) Database name (MySQL only).
database.username (empty) Database username (MySQL only).
database.password (empty) Database password (MySQL only).
entra.enabled false Enables Microsoft Entra ID (Azure AD) authentication.
entra.tenant_id (empty) The Azure AD tenant ID for authentication.
entra.client_id (empty) The Azure AD application (client) ID.
entra.audience (empty) The expected audience for Entra ID tokens.
server.host_name localhost The hostname to use for external links.
server.port 2021 The port on which the server listens.
server.read_timeout 2s The maximum duration for reading the entire request.
server.write_timeout 1s The maximum duration before timing out writes of the response.
server.rate_period 60s The period for rate limiting.
server.rate_limit 300 The maximum number of requests allowed within the rate period.
server.serve_frontend true Indicates if the frontend should be served by the backend server.
server.registration true Indicates whether new accounts can be created when users first sign in.
server.log_level debug when server.debug = true, else warn The min level to log (debug, info, warn, error, dpanic, panic, fatal).
server.allowed_origins (empty) Origins allowed to issue cross-domain requests.
server.allow_credentials false Whether cross-domain requests can include credentials.
scheduler_jobs.due_frequency 5m The interval for sending regular notifications.
scheduler_jobs.overdue_frequency 24h The interval for sending overdue notifications.
scheduler_jobs.notification_cleanup 10m The interval for cleaning up sent notifications.

Telemetry Configuration

Environment Variable Default Value Description
APPINSIGHTS_CONNECTION_STRING (empty) Azure Application Insights connection string. When empty, telemetry is disabled.

🛠️ Development

A devcontainer configuration is set up in this repo to help jumpstart development with all the required dependencies available for both the frontend and backend. You can use this configuration alongside GitHub codespaces to jump into a remote development environment without installing anything on your local machine. For the best experience make sure your codespace has both repos cloned in it. Ports can be forwarded from within the container so that you are able to test changes locally through the VS Code tunnel.

📃 Requirements

📱 Android App

The Android app lives in the android/ directory:

cd android
./gradlew assembleDebug

🤝 Contributing

Contributions are welcome! If you would like to contribute to this repo, feel free to fork the repo and submit pull requests. If you have ideas but aren't familiar with code, you can also open issues.

🔒 License

See the LICENSE file for more details.