KO
|
EN
gitlite — search
Search
#typescript
#ai-agents
#deepseek-harness
#dsh-plugin
#open-source
#ai
#cli
#dsh
#claude-code
#codex
#developer-tools
#react
dankcalendar
★ 73
Open GitHub ↗
Calendar from the Dank Linux Suite
Download README (.md)
Explore Similar Repositories
PCLHD
:
No description available.
EyecareGPT
:
【ACM MM 2025】Official Repo for Paper ‘’EyecareGPT: Boosting Comprehensive Ophthalmology Understanding with Tailored Dataset, Benchmark and Model‘’
Huawei_Devops_bootcamp
:
Repository For Huawei Devops bootcamp workshop
waffle
:
Wasm Analysis Framework For Lightweight Experiments
cooper
:
No description available.
// repository documentation
Was this content helpful?
★ 0
(0 ratings)
Select Rating:
★
★
★
★
★
Submit Feedback
Recent Feedback
×
Download README
Do you want to download the
README.md
file for
dankcalendar
?
Download (.md)
# DankCalendar <div align="center"> <a href="https://danklinux.com"> <img src="assets/danklogo.svg" alt="DankCalendar" width="200"> </a> ### Local, Google, Microsoft, CalDAV, and iCloud calendars in one standalone app Built with [Quickshell](https://quickshell.org/) and [Go](https://go.dev/) [](https://github.com/AvengeMedia/dankcalendar/stargazers) [](https://github.com/AvengeMedia/dankcalendar/blob/master/LICENSE) [>)](https://aur.archlinux.org/packages/dankcalendar-bin) [>)](https://aur.archlinux.org/packages/dankcalendar-git) [](https://flathub.org/apps/com.danklinux.dankcalendar) [](https://discord.gg/ppWTpKmPgT) [](https://ko-fi.com/danklinux) </div> DankCalendar is a standalone calendar app that brings your Local, [Google](https://calendar.google.com/), [Microsoft](https://outlook.com/), [CalDAV](https://en.wikipedia.org/wiki/CalDAV), and [iCloud](https://www.icloud.com/calendar/) calendars together in one place. It runs as a lightweight daemon with a tray icon, keeps your accounts in sync, and reminds you about events — all with the look and feel of [DankMaterialShell](https://github.com/AvengeMedia/DankMaterialShell). ## Repository Structure This is a monorepo containing both the calendar interface and the core backend services: ``` dankcalendar/ ├── quickshell/ # QML-based calendar interface │ ├── Modules/ # UI components (calendar views, sidebar, tray) │ ├── Modals/ # Settings, account, event, and search dialogs │ ├── Services/ # IPC bridge and shell-side state │ ├── Widgets/ # Calendar-specific Dank UI controls │ ├── Common/ # Shared resources, themes, and i18n │ ├── DankCommon/ # → symlink into the dank-qml-common submodule │ └── translations/ # POEditor-managed string catalogs ├── dank-qml-common/ # Shared DMS widget library (git submodule) ├── core/ # Go backend, daemon, and CLI │ ├── cmd/dcal/ # dcal CLI and daemon entrypoint │ ├── internal/ # Providers, sync engine, reminders, IPC, OAuth │ ├── api/ # HUMA + chi HTTP API │ ├── ent/ # Ent ORM schema and generated code │ └── repo/ # Repository-pattern data access ├── assets/ # Icons, desktop entry, systemd unit └── Makefile # Build, install, and dev targets ``` ## See it in Action <div align="center"> <!-- Screenshots / demo video coming soon --> </div> ## Installation ### Flatpak ```bash flatpak install flathub com.danklinux.dankcalendar flatpak run com.danklinux.dankcalendar ``` ### Arch Linux (AUR) ```bash # Prebuilt binary yay -S dankcalendar-bin # Build from latest git yay -S dankcalendar-git ``` ### From Source ```bash git clone --recurse-submodules https://github.com/AvengeMedia/dankcalendar.git cd dankcalendar sudo make install ``` Already cloned without submodules? Run `git submodule update --init` first — the shared widget library ([dank-qml-common](https://github.com/AvengeMedia/dank-qml-common)) is vendored as a submodule and the build fails without it. This installs: - `dcal` binary to `/usr/local/bin` (the Quickshell UI is embedded in the binary) - Desktop entry + icon Override the prefix with `PREFIX=/usr sudo make install`. At launch the embedded UI is unpacked read-only into the session runtime dir (`$XDG_RUNTIME_DIR/dankcal-shell/`, tmpfs) and verified against the binary on every start, so editing the unpacked files has no effect. To run a modified copy of the UI, point dcal at any directory containing a `shell.qml` with `dcal -c <dir>` or the `DANKCAL_SHELL_DIR` environment variable — there is no implicit filesystem lookup otherwise. Optional session service (starts the daemon at login, restarts on failure): ```bash make install-systemd systemctl --user enable --now dcal ``` You can also toggle **Start at login** from Settings → General, which manages an XDG autostart entry that launches `dcal run -d --hidden`. ### Requirements - [Quickshell](https://quickshell.org) (`qs`) - Qt 6 declarative (including `Qt.labs.platform` for the tray icon) - Go 1.25+ (build only — the binary is pure Go, no CGO) ## Features **Multiple Providers** Connect Local, Google, Microsoft, CalDAV, and iCloud accounts and view every calendar in a single unified agenda. **Background Sync** A lightweight daemon keeps your accounts in sync and serves the UI over IPC. Closing the window only hides it — sync and reminders keep running. **Event Reminders** Native desktop notifications for upcoming events, with per-event and per-calendar reminder configuration. **Tray Integration** A system tray icon to show, hide, and quit the app, plus quick access to upcoming events. **Secure Credentials** OAuth tokens and account secrets are stored in your system keyring, never in plaintext. **Keyboard Navigation** Full keyboard-driven navigation with a shortcuts overlay, plus spotlight-style search across your events. **Localized** User-facing strings are translatable and managed through POEditor. ## Usage ```bash dcal # launch, or show/focus the window if already running dcal show # same as above dcal show --view day # open (or focus) directly on a view: month|week|day|agenda dcal toggle # toggle window visibility dcal run # run in the foreground (logs to the terminal) dcal run -d # run as a background daemon dcal restart # restart the running shell dcal kill # stop everything ``` Closing the window only hides it — the daemon and tray icon keep running. Reopen from the tray icon, the desktop entry, or `dcal show`. Quit entirely from the tray menu or `dcal kill`. Manage accounts and sync from the command line: ```bash dcal account list # list connected accounts dcal account add local ~/cal # add a local calendar directory dcal account add caldav # add a CalDAV / iCloud account dcal account add google # sign in with Google (opens your browser) dcal account add microsoft # sign in with Microsoft (opens your browser) dcal account setup google # optional: use your own Google OAuth client dcal account setup microsoft # optional: use your own Microsoft app registration dcal account remove <account-id> # remove an account dcal sync [account-id] # force a sync dcal reminders # list upcoming reminders ``` ## IPC The daemon exposes a scriptable IPC surface — handy for keybinds and automation: ```bash dcal ipc ui.toggle dcal ipc ui.show dcal ipc ui.show view=day # open on a specific view: month|week|day|agenda dcal ipc ui.openEvent uid=<uid> # open a specific event's details window dcal ipc events.list from=2026-06-01 to=2026-06-30 dcal ipc accounts.list dcal ipc reminders.upcoming dcal ipc system.autostart ``` ## Development ```bash git submodule update --init # once after clone (or clone with --recurse-submodules) make run # build and run against the in-repo quickshell config make test # run the Go test suite make fmt # format Go code make update-common # bump the dank-qml-common submodule + nix flake input together ``` Shared widgets (`quickshell/DankCommon/`) live in the [dank-qml-common](https://github.com/AvengeMedia/dank-qml-common) submodule — edit them in place, they hot-reload like any other QML, but they are committed and PR'd in that repo. See CONTRIBUTING for the workflow. > **Tip:** Run with hot reload to pick up QML changes without restarting: > > ```bash > # from core/ > DCAL_ENABLE_HOTRELOAD=1 go run ./cmd/dcal run -c ../quickshell > ``` Install [prek](https://prek.j178.dev/) and activate the hooks: ```bash prek install ``` The hooks run `gofmt -s`, `go vet`, `go mod tidy`, and the Go test suite for changes under `core/`, plus generic whitespace/YAML checks. See [CONTRIBUTING.md](CONTRIBUTING.md) for editor setup, the i18n workflow, and Go style guidelines. ## Contributing Contributions welcome. Bug fixes, widgets, features, providers, and translations all help. 1. Fork the repository 2. Make your changes 3. Test thoroughly (`make test`) 4. Open a pull request Include screenshots or video in your PR when the change is user-facing. ## Credits - [Quickshell](https://quickshell.org/) - Shell framework - [DankMaterialShell](https://github.com/AvengeMedia/DankMaterialShell) - Design language and widgets - [Ent](https://entgo.io/) - Go ORM - [HUMA](https://huma.rocks/) - HTTP API framework ## License MIT License - See [LICENSE](LICENSE) for details. ### OAuth client credentials This repository includes a Google OAuth client and a Microsoft app registration so `dcal account add google` and `dcal account add microsoft` work out of the box. Distribution packages built from this repository (AUR, Flathub, Fedora, Debian, Nix, and the like) are welcome to ship them unchanged — no special permission is needed to package or redistribute DankCalendar. These credential strings identify the upstream DankCalendar application to Google and Microsoft. They are not authorized for use by forks, rebranded builds, or unrelated applications — under [Google's API Services Terms](https://developers.google.com/terms) and Microsoft's identity platform terms, such projects must register their own OAuth clients and supply them at build time via `-ldflags -X`, at runtime via `DANKCAL_GOOGLE_CLIENT_ID` / `DANKCAL_GOOGLE_CLIENT_SECRET` / `DANKCAL_MICROSOFT_CLIENT_ID`, or in-app via the custom OAuth client option.
