Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added WIP mermaid architecture diagram #1086

Merged
merged 2 commits into from
Jul 13, 2024
+30 −2
Merged

docs: added WIP mermaid architecture diagram #1086

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d51cb07
docs: added WIP mermaid architecture diagram
ErikBjare Jul 10, 2024
9e65022
docs: improvements to WIP mermaid diagram
ErikBjare Jul 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
</p>

<p align="center">

<a href="https://twitter.com/ActivityWatchIt">
<img title="Twitter follow" src="https://img.shields.io/twitter/follow/ActivityWatchIt.svg?style=social&label=Follow"/>
</a>
Expand All @@ -33,7 +32,6 @@
</p>

<p align="center">

<a href="https://github.com/ActivityWatch/activitywatch/actions?query=branch%3Amaster">
<img title="Build Status GitHub" src="https://github.com/ActivityWatch/activitywatch/workflows/Build/badge.svg?branch=master" />
</a>
Expand Down Expand Up @@ -181,6 +179,36 @@ We have a plan to address all of these and we're well on our way. See the table
For a complete list of the things ActivityWatch can track, [see the page on *watchers* in the documentation](https://docs.activitywatch.net/en/latest/watchers.html).


## Architecture

```mermaid
graph TD;
aw-qt -- Manages --> S;
aw-qt -- Manages --> aw-notify -- Queries --> S;
aw-qt -- Manages --> W1[aw-watcher-window] -- Watches --> S1[Active window] -- Heartbeats --> S[aw-server];
aw-qt -- Manages --> W2[aw-watcher-afk] -- Watches --> S2[AFK status] -- Heartbeats --> S[aw-server];
Browser -- Manages --> aw-watcher-web -- Watches --> S3[Active tab] -- Heartbeats --> S;
SF -- Dropbox/Syncthing/etc --> SF;
S <-- aw-sync --> SF[Sync folder];
S -- Serves --> UI[aw-webui];

%% User -- Interacts --> UI;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The commented-out class definitions and link styles in the Mermaid diagram are not used and could be removed to avoid clutter and confusion in the documentation.

%% User -- Observes --> aw-notify;
%% User -- Interacts --> aw-qt;

classDef lightMode fill:#FFFFFF, stroke:#333333, color:#333333;
classDef darkMode fill:#333333, stroke:#FFFFFF, color:#FFFFFF;

classDef lightModeLinks stroke:#333333;
classDef darkModeLinks stroke:#FFFFFF;

class A,B,C,D,E,G lightMode;
class A,B,C,D,E,G darkMode;

%% linkStyle 0 stroke:#FF4136, stroke-width:2px;
%% linkStyle 1 stroke:#1ABC9C, stroke-width:2px;
```

## About this repository

This repo is a bundle of the core components and official modules of ActivityWatch (managed with `git submodule`). Its primary use is as a meta-package providing all the components in one repo; enabling easier packaging and installation. It is also where releases of the full suite are published (see [releases](https://github.com/ActivityWatch/activitywatch/releases)).
Expand Down
Loading