Reading the repo

Opening the box…

How to set up tickr (Yoas1/tickr) · gitmanual

Assembly instructions

Yoas1/tickr

PythonFastAPI

Difficulty: Easy
Time: about 5 min
Stars: ★ 0
Activity: Updated 2 months ago
License: MIT
Open issues: 0
Got it running: Be the first
Looked up: 4 h ago

Saved setup from 4 h ago

Start here

Will it work on my device?

Yes, with Docker on macOS

It's a self-hosted app: the README runs it with Docker, and you open it in your browser.
On macOS that means installing Docker Desktop first.

Supported devices from the README: Platform

Works offline — an offline-first client applies actions instantly and syncs with the server in the background; a pending-changes chip shows sync state.
Installable PWA — add Tickr to your home screen / install it from the browser as an app.
Notifications — opt-in alerts on Telegram, Gotify, e-mail or any Apprise channel: task changes, "starting soon" reminders, due reminders, and admin alerts.
API keys — generate bearer tokens for scripts and automation, and revoke them at any time.
Dark / light theme — switch at any time from Settings (light by default).
Responsive layout — pinned full-width header, a fixed menu with independently scrolling projects, and a mobile bottom-sheet drawer.
Self-contained — one container, one SQLite file, zero external services.

Checking for

Run it with Docker

A self-hosted app: Docker runs it on your computer and you open it in the browser. Needs Docker Desktop (or Docker Engine on Linux). Run docker compose commands inside the cloned repo folder.

Docker

docker run -d --name tickr -p 8000:8000  -e TODO_DB_PATH=/data/todo.db  -e UPLOADS_DIR=/data/uploads  -v tickr-data:/data  yoas1/tickr:latest

Docker

docker compose up -d

From the README, exactly as the maintainers wrote it.

Did you get it running?

No reports for macOS yet.

Still stuck? Ask an AI

Opens a chat with this manual already filled in, for macOS. It uses your own account; gitmanual sends nothing.

Ask Claude Ask ChatGPT