Skip to content

About

Framework-agnostic skeleton for @owdproject/*-desktop distributions

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

OWD Desktop Template

Powered by @owdproject/core — the framework-agnostic skeleton for every @owdproject/<framework>-desktop distribution.

Overview

This repository is the shared skeleton for OWD desktop distributions. A framework distribution such as @owdproject/nuxt-desktop, @owdproject/react-desktop or (later) @owdproject/svelte-desktop is this skeleton plus a thin framework layer.

It is a host, not an extension: it composes apps, modules and themes around the framework-independent engine @owdproject/core. The contract it implements is @owdproject/core → Desktop distribution contract.

Layout

apps/       kind: app    → @owdproject/<framework>-app-*
modules/    kind: module → @owdproject/<framework>-module-*   (monorepos may use packages/*)
themes/     kind: theme  → @owdproject/<framework>-theme-*
plugins/    optional workspace slot
presets/    demo/preset data for playgrounds
packages/   module/kit packages in a monorepo layout
desktop/    the host — filled by the framework layer (framework config + composition + entry)
template/   generated starter — produced by the CLI, do not hand-edit
scripts/    contract guards
.owd/       control-panel settings

*=template repos are scaffolds, not extensions.

Instantiate a framework distribution

Copy this skeleton into <framework>-desktop/ and add the framework layer described in docs/framework-layer.md:

  1. depend on the engine (@owdproject/core) and the adapter (@owdproject/<framework>);
  2. add the framework config and the composition file (desktop.config.ts or the adapter's equivalent) under desktop/;
  3. add the entry point and a default theme/kit;
  4. add the framework starter blueprint used by create-owd;
  5. keep the contract guards in scripts/ — do not re-implement them.

License

Open Web Desktop is released under the MIT License.

About

Framework-agnostic skeleton for @owdproject/*-desktop distributions

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages