{"id":13728771,"url":"https://github.com/kbkpbot/vxui","last_synced_at":"2025-05-08T01:30:21.492Z","repository":{"id":166641635,"uuid":"641959374","full_name":"kbkpbot/vxui","owner":"kbkpbot","description":"vxui is a cross-platform desktop UI framework which use your browser as screen, and use V lang as backend. It reply on Websocket, no http/https, no web server!","archived":false,"fork":false,"pushed_at":"2025-02-04T12:32:12.000Z","size":2400,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-04T13:30:59.882Z","etag":null,"topics":["cross-platform","desktop","htmx","ui","vlang","websocket","webui"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kbkpbot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2023-05-17T14:16:02.000Z","updated_at":"2025-02-04T12:32:16.000Z","dependencies_parsed_at":"2024-11-14T19:33:51.766Z","dependency_job_id":"44f2a096-4316-4535-8564-70c3c06ce095","html_url":"https://github.com/kbkpbot/vxui","commit_stats":null,"previous_names":["kbkpbot/vxui"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kbkpbot%2Fvxui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kbkpbot%2Fvxui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kbkpbot%2Fvxui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kbkpbot%2Fvxui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kbkpbot","download_url":"https://codeload.github.com/kbkpbot/vxui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252981348,"owners_count":21835413,"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":["cross-platform","desktop","htmx","ui","vlang","websocket","webui"],"created_at":"2024-08-03T02:00:50.007Z","updated_at":"2025-05-08T01:30:20.780Z","avatar_url":"https://github.com/kbkpbot.png","language":"JavaScript","funding_links":[],"categories":["👓 Alternatives to the [Electron.js](https://electronjs.org) ⚛"],"sub_categories":["V"],"readme":"# vxui\n\n\u003e :warning: **Notice**:\n\u003e\n\u003e\n\u003e * vxui it's not a web-server solution or a framework, but it's an lightweight portable lib to use installed web browser as a user interface.\n\u003e\n\u003e * Currently, vxui is in it's alpha stage.\n\n\n* vxui = browser + htmx/webui + websocket + v *\n\n## Introduction\n\nvxui is a cross-platform desktop UI framework which use your browser as screen, and use V lang as backend. It reply on Websocket, no http/https, no web server!\n\n## Motivation\n\n* Every desktop should has a installed web browser, and it's display it much better than native GUI. Because there are too many frontend designers in the world!\n* When develop a desktop framework with HTML+CSS+JS, why should we integrate a web server? By using websocket, we can totally bypass the integerated web server!\n\n## Features\n\n* Cross-platform. It should be able to running on Windows/Linux/MacOS;\n* Extensible. You can use any frontend framework develop your UI, all you need is just add some tags in your html files;\n* Light weight. vxui contain only a pure-V websocket server, no web server;\n* Powerful. vxui backend can communication with frondend bi-direction and realtime;\n* Flexible. vxui provide websocket-based communication, you can totally define your own protocol, no longer limited by AJAX's request-response model.\n\n## Inside vxui\n\n![vxui](vxui.png)\n\n* frontend: It is your installed web browser. And a modified vesion of [htmx](https://htmx.org) with vxui_htmx.js are all you need.\n* backend: [v](https://vlang.io/)\n* between frondend and backend, it is websocket.\n\n- When you start your App, it will first look for a free port on your OS, then the websocket server listen on this port;\n- The App will use command line spawn a process, start the web server, which will open your UI's first html file;\n  Every your UI html file should include a JS agent file.\n- The JS agent in your html file will use the port communication with backend websocket server;\n- By using htmx or webui, every event catch by the JS agent(mouse click, keyup, text change...), will be transfered to your backend;\n  Currently, vxui will replace all AJAX request in your htmx files with websocket communication.\n\n## Example\n\n```html\n\u003cscript src=\"./js/htmx.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"./js/vxui_htmx.js\"\u003e\u003c/script\u003e\n\u003cspan hx-ext=\"vxui_htmx\"/\u003e\n  \u003c!-- have a button POST a click via websocket --\u003e\n  \u003cbutton hx-post=\"/clicked\" hx-swap=\"outerHTML\"\u003e\n    Click Me\n  \u003c/button\u003e\n```\nThe `hx-post` and `hx-swap` attributes tell htmx \u0026 vxui-htmx:\n\n\u003e \"When a user clicks on this button, issue an websocket request to /clicked(`hx-post`), and replace the entire button with the response(`hx-swap`)\"\n\nAnd your websocket server will recieve this message:\n```json\n{\"verb\":\"post\",\"path\":\"/clicked\",\"elt\":\"BUTTON\",\"parameters\":{},\"HEADERS\":{\"HX-Request\":\"true\",\"HX-Trigger\":null,\"HX-Trigger-Name\":null,\"HX-Target\":null,\"HX-Current-URL\":\"file:///home/kbkpbot/.vmodules/vxui/static/ss.html\"}}\n```\n\n## Quick start\n\n* install vxui\n```sh\n\tv install --git https://github.com/kbkpbot/vxui.git\n```\n* check examples\n\n## License\n\nMIT license\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkbkpbot%2Fvxui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkbkpbot%2Fvxui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkbkpbot%2Fvxui/lists"}