{"id":25895411,"url":"https://github.com/diamondlightsource/mx-daq-ui","last_synced_at":"2026-02-24T16:02:26.599Z","repository":{"id":265494961,"uuid":"894433466","full_name":"DiamondLightSource/mx-daq-ui","owner":"DiamondLightSource","description":"Web UIs for MX DAQ","archived":false,"fork":false,"pushed_at":"2026-01-26T10:39:58.000Z","size":5782,"stargazers_count":1,"open_issues_count":27,"forks_count":0,"subscribers_count":16,"default_branch":"main","last_synced_at":"2026-01-27T00:34:55.053Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DiamondLightSource.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-11-26T10:53:28.000Z","updated_at":"2026-01-21T09:56:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"fa0efb07-042b-4ad2-ba13-915697743593","html_url":"https://github.com/DiamondLightSource/mx-daq-ui","commit_stats":null,"previous_names":["diamondlightsource/mx-daq-ui"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DiamondLightSource/mx-daq-ui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiamondLightSource%2Fmx-daq-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiamondLightSource%2Fmx-daq-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiamondLightSource%2Fmx-daq-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiamondLightSource%2Fmx-daq-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DiamondLightSource","download_url":"https://codeload.github.com/DiamondLightSource/mx-daq-ui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiamondLightSource%2Fmx-daq-ui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29012691,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-02T12:48:30.580Z","status":"ssl_error","status_checked_at":"2026-02-02T12:46:38.384Z","response_time":58,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2025-03-02T22:31:14.465Z","updated_at":"2026-02-02T13:00:03.682Z","avatar_url":"https://github.com/DiamondLightSource.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Prototype web gui, for I24 serial, I23 laser shaping, and whatever else\n\n## Installation\n\nOn a DLS workstation, clone the repository and inside it run:\n\n```bash\nmodule load vscode\n\ncode .\n```\n\nWhen vscode opens, select `Reopen in container` to get a working environment with `pnpm` installed.\n\nOn a non-dls workstation you have the option of opening the devcontainer or installing pnpm globally and then running the app.\nTo install the app:\n\n```bash\npnpm install\n```\n\n## Gotchas\n\n### PVWS\n\nTo connect to the Diamond PVWS instance at `pvws.diamond.ac.uk`, we take advantage of the [cs-web-lib]https://github.com/DiamondLightSource/cs-web-lib) package - the current stable version being `0.9.10`. PVWS is now configured by setting up the parameters in a JSON config file which is loaded at runtime. The `pvwsconfig.json` is located in the `/public` directory to make it always accessible at runtime.\n\n### Environment variables\n\nTo connect to the BlueAPI instance for I24, the environment variables `VITE_BLUEAPI_SOCKET` must be set to the URL in the file `.env`. The URL is currently set to localhost - but should change to the ingress once the UI is deployed to the beamline cluster.\n\n### BlueAPI config\n\nSettings for connecting to BlueAPI should also be in the .env file.\nFor I23, there is a branch on mx-bluesky https://github.com/DiamondLightSource/mx-bluesky/tree/i23_and_ui_testing which has some test devices and plans. This UI expects to connect to a local instance of BlueAPI with those plans and devices loaded. You can use the config\n\n```yaml\nenv:\n  sources:\n    - kind: dodal\n      module: mx_bluesky.ui_working.devices\n    - kind: planFunctions\n      module: mx_bluesky.ui_working.plans\n\nstomp:\n  host: localhost\n  port: 61613\n  auth:\n    username: guest\n    # This is for local development only, production systems should use good passwords\n    password: guest\n```\n\nFor I24 instead, The first few plans are in the branch https://github.com/DiamondLightSource/mx-bluesky/tree/151_web-ui-first-plans and there is already a BlueAPI configuration defined in https://github.com/DiamondLightSource/mx-bluesky/blob/main/src/mx_bluesky/beamlines/i24/serial/blueapi_config.yaml that can be used for testing.\n\n## Run\n\nOnce all the above steps are done, start a blueapi server. The gui can be started by running:\n\n```bash\npnpm run dev\n```\n\ninside the repository and clicking on the link.\n\n## Make a release\n\nMake a release from the github `Releases` page and point it to either a tag or a branch.\nThere is a workflow job that will then build the app and publish a docker image - which is necessary\nfor deployment.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiamondlightsource%2Fmx-daq-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdiamondlightsource%2Fmx-daq-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiamondlightsource%2Fmx-daq-ui/lists"}