Custom Workspace Seed Project

A seed project generated with @interopio/iocd-cli that sets up a custom workspace acting as a shell in io.Connect Desktop.

Overview

This project demonstrates how to configure io.Connect Desktop to use an externally hosted custom workspace application as the main shell, replacing the default embedded shell.

Important: The workspace application is hosted externally from this repository. It is currently configured to point to http://localhost:5176/ (see workspaces.json).

Changes from Default Seed Setup

This project includes the following modifications over the default seed setup:

1. Added workspaces.json - Defines a custom workspace app that acts as the shell

   • Location: modifications/base/iocd/config/apps/workspaces.json
   • Configures the workspace UI to load from an external URL (http://localhost:5176/)

2. Updated system.json.merge - Disables the default embedded shell

   • Location: modifications/base/iocd/config/system.json.merge
   • Sets useEmbeddedShell to false to allow the custom workspace to take over as the shell

3. Updated iocd.cli.config.json - Configured to use prerelease versions

   • Location: config/iocd.cli.config.json
   • Sets usePrereleases to true to enable prerelease component versions
   • Fixed iocd version to 10.0.3 (a prerelease version)

Quick Start

Prerequisites

• Node.js (v18 or later recommended)
• npm
• Your custom workspace application running at http://localhost:5176/ (or update the URL in workspaces.json)

Installation

npm install

Running in Development Mode

1. Start your custom workspace application (should be available at http://localhost:5176/)
2. Run the io.Connect Desktop seed:

npm run dev

Configuration

To point to a different workspace application URL, update the url property in modifications/base/iocd/config/apps/workspaces.json:

{
    "details": {
        "url": "http://localhost:5176/"
    }
}