Eclipse EMF Cloud ModelHub

This repository contains a framework. It is meant as a library or platform for implementing certain features or types of products, or can be used as a product directly. It is designed to be reusable, customizable, and ready for production.

This repository is under active development. The maintainers of this repository are actively developing new features and releasing new versions.

For more information, please visit the EMF Cloud Website.

If you are interested in adopting this framework for your product or enhancing its feature spectrum, please get in contact with us using the discussions forum and have a look at our support options!

Model Management

A generic Typescript based model management framework.

Available via NPM

• @eclipse-emfcloud/model-accessor-bus
• @eclipse-emfcloud/model-manager
• @eclipse-emfcloud/model-service-theia
• @eclipse-emfcloud/model-service
• @eclipse-emfcloud/model-validation
• @eclipse-emfcloud/trigger-engine

Example application

A generic example application is provided here and can be used as bootstrap for any feature using Model Management. The documentation can be found here.

Development

User Guide

A comprehensive user's guide to development with the Model Management frameworks is available here.

Prerequisites

• Node >= 18.0.0
• yarn >= 1.7.0 AND < 2.0.0

Scripts

Basic setup

• yarn to setup monorepo and transpile all packages. This does not build the example applications.

Build scripts

• yarn build to transpile all packages and build example applications.
• yarn build:npm to transpile npm packages.
• yarn build:examples to transpile example packages and build example applications.

Watch script

• yarn run watch to watch all packages including the example applications

Start example apps

• yarn browser start
• yarn electron start
• yarn electron start:validation

Alternatively you can use the VS Code launch configurations.

Remark: If the Electron example fails to start due to drivelist errors, the issue can often be resolved by running git clean -fdx and reinstalling all node_modules via yarn.

Run tests

• yarn test to execute all tests
• yarn test:coverage to execute all tests including coverage measurement

License

This program and the accompanying materials are made available under the terms of the Eclipse Public License v. 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License v. 2.0 are satisfied: MIT.

SPDX-License-Identifier: EPL-2.0 OR MIT