{"id":23449155,"url":"https://github.com/oeway/imjoy-desktop","last_synced_at":"2026-02-26T08:41:59.694Z","repository":{"id":138962423,"uuid":"385157447","full_name":"oeway/imjoy-desktop","owner":"oeway","description":null,"archived":false,"fork":false,"pushed_at":"2021-07-12T12:43:51.000Z","size":116,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-15T18:32:56.473Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oeway.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":"2021-07-12T07:12:51.000Z","updated_at":"2021-09-23T17:08:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"7bace8be-c85c-4e21-993a-9e5c18b3aa8e","html_url":"https://github.com/oeway/imjoy-desktop","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oeway%2Fimjoy-desktop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oeway%2Fimjoy-desktop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oeway%2Fimjoy-desktop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oeway%2Fimjoy-desktop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oeway","download_url":"https://codeload.github.com/oeway/imjoy-desktop/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248144658,"owners_count":21054966,"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":[],"created_at":"2024-12-23T22:20:23.186Z","updated_at":"2026-02-26T08:41:54.677Z","avatar_url":"https://github.com/oeway.png","language":null,"funding_links":["https://www.patreon.com/hacklover","https://img.shields.io/badge/dynamic/json?color=%23e85b46\u0026label=patreon\u0026query=data.attributes.patron_count\u0026suffix=%20patrons\u0026url=https://www.patreon.com/api/campaigns/1208485","https://www.liberapay.com/hacklover"],"categories":[],"sub_categories":[],"readme":"# Open Web Desktop - Client\n\n\u003cp\u003e\n    \u003cimg src=\"https://i.imgur.com/9peh1BX.png\" alt=\"Open Web Desktop\" /\u003e\n\u003c/p\u003e\n\n\u003cp\u003e\n    \u003ca href=\"https://github.com/owdproject/owd-client\"\u003e\u003cimg src=\"https://img.shields.io/github/release/owdproject/owd-client.svg?color=1895b1\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://npmjs.com/package/@owd-client/core\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/@owd-client/core.svg?color=1895b1\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/owdproject/owd-client\"\u003e\u003cimg src=\"https://img.shields.io/badge/owd-client-blue\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/topics/owd-modules\"\u003e\u003cimg src=\"https://img.shields.io/badge/owd-modules-777\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://discord.gg/3KFVP8b\"\u003e\u003cimg src=\"https://img.shields.io/discord/759699532896010261?color=7289da\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Overview\nOpen Web Desktop is a project that aims to provide a simple environment to create your own web desktop, and to be able to extend it through a series of modules and integrations. OWD Client is based on Vue.js 3 and TypeScript.\n\n[Check the demo](https://demo.owdproject.org) of this `owd-client` base repository, decked out with some modules.\n\n## Features\n- Open-source web desktop client based on Vue.js 3\n- Fully extendable through app and desktop modules\n- Fully extendable through pages and Vue components\n- Notifications, terminal commands, multiple themes\n- Vuex, Vue Router and Vue i18n implemented by default\n- Vuetify.js and Moment.js implemented by default\n- TypeScript and Vite support\n\n## About this project\nOpen Web Desktop is divided in two main repositories:\n- [owd-client](https://github.com/owdproject/owd-client): Open Web Desktop client, made with Vue.js 3\n- [owd-server](https://github.com/owdproject/owd-server): Open Web Desktop server, made with Nest.js (TBA)\n\n## Getting started\nRequired software:\n\n- [Git](https://git-scm.com)\n- [Node](https://nodejs.org)\n\nWhen you are ready, bootstrap a new instance by running:\n```\nnpx create-owd-app \u003cmy-client\u003e\n```\nOnce the process is complete, you can start with the client development.\n```\n# Run the dev server\nnpm run serve\n\n# Build for production\nnpm run build\n```\n\n## Modules\nOWD modules can extend your Open Web Desktop instance.  \nYou can find some modules available for all at [topics/owd-modules](https://github.com/topics/owd-modules).\n\n### Install a new module\nYou can simply install a new module with `npm install \u003cgit-link\u003e`, unless you want to customize it.\n\n#### Install a new module by importing its source\nIf you are planning to customize a module, just import its source by copying the content of the `owd-module/client` folder into `src/modules/app/\u003cmodule-name\u003e`.\nAlways check the `README.md`, you may have to move some folders.\n\nAlso take a look at the `package.json`, there may be additional dependencies to install, or other OWD modules.\nFor each dependency you find listed, install it by running `npm install \u003cdependency\u003e` in the root folder of your instance.\n\n#### Define the installed module\nTo load an installed module, define it under `my-owd-client/client.extensions.ts`.  \nBe sure to add every module in the `app.modules` array like the default ones:\n\n```js\nimport AboutModule from \"@owd-client/core/src/modules/app/about\";\nimport DebugModule from \"@owd-client/core/src/modules/app/debug\";\nimport CustomModuleSource from \"./src/modules/app/custom-module\";\nimport CustomModuleInstalled from \"owd-custom-module\";\n\nexport default {\n  app: {\n    modules: [\n      AboutModule,\n      DebugModule,\n      CustomModuleSource,\n      CustomModuleInstalled\n    ]\n  },\n  ...\n```\n\n## Contributing\n\n### Local development\nOWD Client repository is a Yarn workspaces monorepo that includes the client boilerplate, the client core, and in the future also something else (like the docs), just to keep everything in a single place.\n\n### Setting up your environment\n\nRequired software:\n\n- [Git](https://git-scm.com)\n- [Node](https://nodejs.org)\n- [Yarn](https://classic.yarnpkg.com)\n\nOnce you have everything installed, clone the repository:\n\n```\n# Using HTTPS\ngit clone https://github.com/owdproject/owd-client.git\n\n# Using SSH\ngit clone git@github.com:owdproject/owd-client.git\n```\n\nThen install all the dependencies, and run Open Web Desktop in development mode.\n```\n# Navigate to the owd-client folder\ncd owd-client\n\n# Install dependencies using yarn\nyarn install\n\n# Run OWD in development mode\nyarn serve\n```\nThis will bootstrap the Yarn workspaces, allowing you to run and edit both client and core packages.   \nIf you intend to contribute to the project, please join our [community chat](https://discord.gg/3KFVP8b).\n\n## Supporters\n\nYour support is essential to keep this project active.  \nIf you find it useful, please consider donating.\n\nSee all sponsors \u0026 backers in the [BACKERS.md](BACKERS.md)\n\n\u003ca href=\"https://www.patreon.com/hacklover\"\u003e\n    \u003cimg alt=\"Open Web Desktop Patreon\" src=\"https://img.shields.io/badge/dynamic/json?color=%23e85b46\u0026label=patreon\u0026query=data.attributes.patron_count\u0026suffix=%20patrons\u0026url=https://www.patreon.com/api/campaigns/1208485\" /\u003e\n\u003c/a\u003e\n\u0026nbsp;\n\u003ca href=\"https://www.liberapay.com/hacklover\"\u003e\n    \u003cimg alt=\"Open Web Desktop Liberapay\" src=\"https://img.shields.io/liberapay/receives/hacklover?label=liberapay\" /\u003e\n\u003c/a\u003e\n\n## License\nThis project is released under the [GNU GPL3 License](LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foeway%2Fimjoy-desktop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foeway%2Fimjoy-desktop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foeway%2Fimjoy-desktop/lists"}