Template Module

Quick start a new Open Web Desktop module.

Overview

A template for your new Open Web Desktop module. This template is designed to help you quickly bootstrap and build custom Nuxt modules that extend the core desktop functionality.

Demo · Documentation · Support

Getting Started

Method 1: Using the OWD CLI (Recommended)

Run the following command in your OWD workspace root to scaffold a new module automatically:

pnpm desktop create module <name>

This command will:

• Copy the template files into packages/module-<name>
• Perform package name and namespace replacements
• Run pnpm install in the workspace root
• Link the new module and register it under the modules key in your desktop/desktop.config.ts

Method 2: Manual Installation

If you prefer to manually clone and set up the module template:

1. Download or clone this repository into your /packages directory:

   cd <your-owd-client-path>/packages
   wget -O - https://github.com/owdproject/module-template/archive/refs/heads/main.zip | unzip -d module-<name> -

2. Open the newly created packages/module-<name>/package.json and change the "name" field to @owdproject/module-<name>.

3. Register the module under the modules key in your desktop/desktop.config.ts:

   export default defineDesktopConfig({
     modules: [
       '@owdproject/module-<name>'
     ]
   })

4. Install dependencies in your workspace to enable internal linking:

   pnpm install

Development

Run the module playground to test your implementation:

cd packages/module-<name>
pnpm run dev

License

This application is released under the MIT License.