{"id":13870237,"url":"https://github.com/ActivityWatch/aw-webui","last_synced_at":"2025-07-15T20:31:54.426Z","repository":{"id":38107390,"uuid":"57234836","full_name":"ActivityWatch/aw-webui","owner":"ActivityWatch","description":"Webapp for visualizing and browsing ActivityWatch data, built with Vue.js.","archived":false,"fork":false,"pushed_at":"2024-10-05T11:03:29.000Z","size":12374,"stargazers_count":106,"open_issues_count":66,"forks_count":110,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-10-30T00:54:48.895Z","etag":null,"topics":["activitywatch","vue","webui"],"latest_commit_sha":null,"homepage":"","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ActivityWatch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["ActivityWatch"],"open_collective":"activitywatch","liberapay":"ActivityWatch","custom":["https://activitywatch.net/donate/"]}},"created_at":"2016-04-27T18:02:03.000Z","updated_at":"2024-10-19T21:18:39.000Z","dependencies_parsed_at":"2024-04-12T03:30:46.692Z","dependency_job_id":"b37d33e6-5e05-4a8a-bf24-006728ea0869","html_url":"https://github.com/ActivityWatch/aw-webui","commit_stats":{"total_commits":1070,"total_committers":65,"mean_commits":16.46153846153846,"dds":"0.42242990654205603","last_synced_commit":"0cf7831771d9cad9e25954eaed99c77d5a7c6e10"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActivityWatch%2Faw-webui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActivityWatch%2Faw-webui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActivityWatch%2Faw-webui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActivityWatch%2Faw-webui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ActivityWatch","download_url":"https://codeload.github.com/ActivityWatch/aw-webui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225230868,"owners_count":17441505,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["activitywatch","vue","webui"],"created_at":"2024-08-05T20:01:36.252Z","updated_at":"2024-11-23T16:31:23.241Z","avatar_url":"https://github.com/ActivityWatch.png","language":"Vue","readme":"# aw-webui\n\nA web-based UI for ActivityWatch, built with Vue.js\n\n[![Build Status](https://github.com/ActivityWatch/aw-webui/workflows/Build/badge.svg)](https://github.com/ActivityWatch/aw-webui/actions)\n[![Coverage Status](https://codecov.io/gh/ActivityWatch/aw-webui/branch/master/graph/badge.svg)](https://codecov.io/gh/ActivityWatch/aw-webui)\n[![Known Vulnerabilities](https://snyk.io/test/github/ActivityWatch/aw-webui/badge.svg)](https://snyk.io/test/github/ActivityWatch/aw-webui)\n\n## Getting started\n\nGetting started with setting up the development environment is pretty straightforward:\n\n```bash\n# Start an instance of aw-server running in testing mode (on port 5666, with a separate database),\n# This is what the web UI will connect to by default when run in development mode.\naw-qt --testing\n# or, to run without watchers:\naw-server --testing\n\n# Install dependencies\nnpm install\n# or, to get exact versions of dependencies:\nnpm ci\n\n# start aw-webui in dev mode\nnpm run serve\n```\n\nAlternatively, you can run `make dev` to install dependencies and serve the application locally.\n\nYou might have to configure CORS for it to work, see the CORS section below.\n\nYou may also want to generate fake data so you have something to test with, see: https://github.com/ActivityWatch/aw-fakedata/\n\n## Building\n\nTo build the production bundle, simply run the following:\n\n```bash\n# Install dependencies\nnpm ci\n\n# Build for production\nnpm run build\n```\n\n## Using a pre-release with your main install\n\n**Note:** Running a development version of aw-webui with an old aw-server can lead to issues due to version incompatibilities.\n\n### By copying the web-assets to your main install\n\nYou can run a development version of aw-webui with your main version of ActivityWatch by building it (or fetching the latest build from CI) and replacing placing the contents of the `static` directory of your aw-server (or aw-server-rust) installation. For simplicity, back up the original directory for easier switching back.\n\nThe assets are stored in the following directories (relative to your installation directory), depending on if you use aw-server-python (default) or aw-server-rust:\n\n - aw-server-python: `activitywatch/aw-server/aw_server/static/`\n - aw-server-rust: `activitywatch/aw-server-rust/static/`\n\nYou can copy the assets manually from your `make build` or `npm run build` output to the above locations.\n\nOnce you've put the files in the directories, you may have to do a hard refresh in your browser to invalidate any stale caches.\n\n### Using your main install's data\n\nIf you want to actively iterate on `aw-webui` with your local production data (with your production server running), you'll want to use a development build, automatically update it, and connect to your production data. To do this, in `aw-webui` source directory, in one terminal window run:\n\n```bash\nAW_SERVER_URL=\"'http://localhost:5600'\" npx vue-cli-service build --watch --dest=../aw-server/static\n```\n\nIf you want to add `debugger` statements in your code and otherwise break linting rules, you'll need to add a `--skip-plugins=no-debugger` to that command. \nThen, in another terminal (with your venv activated) run:\n\n```shell\npython3 -m http.server --bind 127.0.0.1 27180 --directory ../aw-server/static\n```\n\n## Tests\n\nTests can be run with:\n\n```bash\nnpm test\n```\n\nThere are also E2E tests. You need to have an aw-server and the web UI running in development mode (with `npm run serve`, as instructed above). After you have that setup, you can run the tests with:\n\n```bash\nmake test-e2e\n```\n\n## Development\n\n### CORS\n\nFor development, you'll also have to add/change CORS configuration in the `aw-server` configs by adding `cors_origins = http://localhost:27180` to your\nconfiguration file `/activitywatch/aw-server/aw-server.toml` under respective sections (`server-testing` section when running server in testing mode).\n\n### Code structure\n\nOne of the first things that happen in the application is the execution of `src/main.js`. This loads things such as bootstrap-vue and a bunch of other stuff that's globally used (filters, resources).\n\nThe main.js file then loads the `src/App.vue` file, which is the root component of the application.\n","funding_links":["https://github.com/sponsors/ActivityWatch","https://opencollective.com/activitywatch","https://liberapay.com/ActivityWatch","https://activitywatch.net/donate/"],"categories":["Vue"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FActivityWatch%2Faw-webui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FActivityWatch%2Faw-webui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FActivityWatch%2Faw-webui/lists"}