@wellmo/devkit v0.2.3

@wellmo/devkit (Alpha RC1)

Develop and build Wellmo components using Vue3 or React. To use Vue2, please refer to other devkit @wellmo/component-devkit

Disclaimer: Components built using Devkit v2 are not currently supported in WellmoPro or Wellmo Clients. Our development efforts are hoping to bring this to you as soon as possible.

Introduction

The user interfaces of Wellmo-powered applications are constructed using components and pages. With @wellmo/devkit you can develop custom Wellmo components to use in Wellmo-powered applications. @wellmo/devkit will create a Wellmo-like environment with mocking data for all necessary client-side APIs where development can be done easily.

When the component is ready you can build it with @wellmo/devkit, the build output is a yaml file that can be imported to Wellmo Pro where the end user service is created and managed.

Wellmo Pro has a service page editor where component instances are configured. The available configuration options for a component instance are defined when developing components. How the component is used and how it integrates with the whole service is defined in Wellmo Pro.

Installation

NPM

Prerequisites

$ npm install --global tsx

Wellmo Component Devkit v2

$ npm install --save-dev @wellmo/devkit

CLI

Wellmo provides official CLI (Devkit) that makes easier to start developing Wellmo components with Vue.js and React. It provides basic Wellmo boilerplate component templates for further development.

Usage

Add following scripts to your package.json:

"scripts": {
    "build": "wellmo-devkit build --entry <entryFile> --output <outputDir> --config <configFile> --trackers <mockTrackerDataFile> --data-sources <mockDataSourcesFile> --profile <mockProfileDataFile> --framework <react | vue>,
    "serve": "wellmo-devkit serve --entry <entryFile> --config <configFile> --props <mockPropsFile> --trackers <mockTrackerDataFile> --data-sources <mockDataSourcesFile> --profile <mockProfileDataFile> --images <mockImagesDir> --app-state <mockAppStateFile> --port 3333 --framework <react | vue>",
    "help": "wellmo-devkit --help"
}

License

Enterprise License