@owdproject/core 3.1.1 → 3.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +23 -57
  2. package/bin/owd.js +28 -0
  3. package/package.json +4 -1
package/README.md CHANGED
@@ -8,9 +8,9 @@
8
8
 
9
9
  ## Overview
10
10
 
11
- Open Web Desktop (OWD) is a framework designed to provide a simple environment for building web-based desktop experiences. It's built with Vue.js & TypeScript, and it leverages the extensible Nuxt.js architecture.
11
+ Open Web Desktop (OWD) is a framework designed to provide a simple environment for building web-based desktop experiences. It's built with TypeScript on top of the Nuxt.js framework.
12
12
 
13
- [Demo](https://atproto-os.pages.dev/) · [Documentation](https://owdproject.org/)
13
+ [Demo](https://atproto-os.pages.dev/) · [Community](https://discord.gg/zPNaN2HAaA) · [Documentation](https://owdproject.org/)
14
14
 
15
15
  ## Features
16
16
 
@@ -44,80 +44,46 @@ pnpm run generate
44
44
 
45
45
  ## Extend your desktop
46
46
 
47
- Open Web Desktop can be extended with themes, modules and applications.
47
+ Thanks to Tailwind and PrimeVue, you can create custom themes from scratch and ensure a consistent look across all apps. Each theme defines its own style, making your desktop both cohesive and uniquely yours.
48
48
 
49
- ### Install an application
49
+ [Applications](https://github.com/topics/owd-apps) · [Modules](https://github.com/topics/owd-modules) · [Themes](https://github.com/topics/owd-themes)
50
50
 
51
- You can install a new [application](https://github.com/topics/owd-apps) with:
51
+ ### 🧩 Install an application
52
+
53
+ You can discover new apps by searching for the [owd-apps](https://github.com/topics/owd-apps) tag on GitHub.
54
+
55
+ For example, to install the To-do app:
52
56
 
53
57
  ```bash
54
- pnpm install @owdproject/app-todo
58
+ nx run desktop:install-app --name=@owdproject/app-todo
55
59
  ```
56
60
 
57
- Then, define it in the desktop configuration:
58
-
59
- ```typescript
60
- // desktop/owd.config.ts
61
- export default defineDesktopConfig({
62
- theme: "@owdproject/theme-win95",
63
- apps: [
64
- "@owdproject/app-about",
65
- "@owdproject/app-todo", // define here the app you just installed
66
- ],
67
- modules: []
68
- })
69
- ```
61
+ This will install the package and automatically register it in your desktop configuration.
62
+
63
+ ### 🧩 Install a module
70
64
 
71
- ### Install a module
65
+ You can discover new modules by searching for the [owd-modules](https://github.com/topics/owd-modules) tag on GitHub.
72
66
 
73
- You can install a new [module](https://github.com/topics/owd-modules) with:
67
+ For example, to install the session persistence module:
74
68
 
75
69
  ```bash
76
- pnpm install @owdproject/module-pinia-localforage
70
+ nx run desktop:install-module --name=@owdproject/module-pinia-localforage
77
71
  ```
78
72
 
79
- Then, define it in the desktop configuration:
80
-
81
- ```typescript
82
- // desktop/owd.config.ts
83
- export default defineDesktopConfig({
84
- theme: "@owdproject/theme-win95",
85
- apps: [
86
- "@owdproject/app-about",
87
- "@owdproject/app-todo",
88
- ],
89
- modules: [
90
- "@owdproject/module-pinia-localforage", // define here the module you just installed
91
- ]
92
- })
93
- ```
73
+ ### 🖥️ Themes
94
74
 
95
- ## Themes
96
- You can install a new [theme](https://github.com/topics/owd-themes) in the same way.
75
+ Themes are full desktop environments that style all UI components independently using [PrimeVue](https://primevue.org/).
76
+ Each theme provides a unique look and feel while maintaining consistent functionality across all applications.
97
77
 
98
- ```bash
99
- pnpm install @owdproject/theme-gnome
100
- ```
78
+ You can discover new themes by searching for the [owd-themes](https://github.com/topics/owd-themes) tag on GitHub.
101
79
 
102
- Define the theme in `owd.config.ts`:
103
-
104
- ```typescript
105
- // desktop/owd.config.ts
106
- export default defineDesktopConfig({
107
- theme: "@owdproject/theme-gnome", // define here the theme you just installed
108
- apps: [
109
- "@owdproject/app-about",
110
- "@owdproject/app-todo",
111
- ],
112
- modules: [
113
- "@owdproject/module-pinia-localforage"
114
- ]
115
- })
80
+ ```bash
81
+ nx run desktop:install-theme --name=@owdproject/theme-gnome
116
82
  ```
117
83
 
118
84
  ## Sponsors
119
85
 
120
- Make this project sustainable, your support is crucial to keep it moving forward.
86
+ Be the first to support this project and help us keep it growing! [Sponsor the project](https://github.com/sponsors/owdproject)
121
87
 
122
88
  ## License
123
89
 
package/bin/owd.js ADDED
@@ -0,0 +1,28 @@
1
+ #!/usr/bin/env node
2
+
3
+ import { spawn } from 'child_process';
4
+
5
+ const [, , cmd, pkgName, ...rest] = process.argv;
6
+
7
+ const commandMap = {
8
+ "install-app": "desktop:install-app",
9
+ "install-module": "desktop:install-module",
10
+ "install-theme": "desktop:install-theme",
11
+ };
12
+
13
+ if (!commandMap[cmd]) {
14
+ console.error(`Unknown command: ${cmd}`);
15
+ process.exit(1);
16
+ }
17
+
18
+ if (!pkgName) {
19
+ console.error("Missing package name (e.g., @owdproject/package)");
20
+ process.exit(1);
21
+ }
22
+
23
+ const nxArgs = ["run", commandMap[cmd], `--name=${pkgName}`, ...rest];
24
+
25
+ const child = spawn("pnpm", ["nx", ...nxArgs], {
26
+ stdio: "inherit",
27
+ shell: true,
28
+ });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@owdproject/core",
3
- "version": "3.1.1",
3
+ "version": "3.1.2",
4
4
  "keywords": [
5
5
  "web",
6
6
  "desktop",
@@ -24,6 +24,9 @@
24
24
  },
25
25
  "type": "module",
26
26
  "types": "types/index.d.ts",
27
+ "bin": {
28
+ "owd": "./bin/owd.js"
29
+ },
27
30
  "dependencies": {
28
31
  "@nuxt/kit": "^3.17.2",
29
32
  "@nuxt/fonts": "^0.11.3",