Aspect Model Editor

Table of Contents

• Introduction
• Getting help
• Getting started
  • Setup
  • Install & Run
  • Run As Electron
  • Running E2E (Cypress) Test
• Documentation
• License

Introduction

This project includes the Aspect Model Editor and its documentation. As a user, download the Installer from https://github.com/eclipse-esmf/esmf-aspect-model-editor/releases .

Getting help

Are you having trouble with Aspect Model Editor? We want to help!

• Check the developer documentation
• Check the SAMM specification
• Having issues with the Aspect Model Editor? Open a GitHub issue.

Getting started (for developers)

Artifacts to use

You can clone the repositories to run the aspect model editor. Feel free to contribute. If you want to run the aspect model editor from repositories, please ensure to clone and start the backend first.

Setup

• Download & Install Node.js
• To generate Aspect Model documentation, the installation GraphViz is required.

First steps into the code: Code Overview

Install & Run

# enter the core directory where the package.json is located
cd core

npm install
npm run start

Run As Electron

After running npm start run one of the following commands:

Windows:

npm run start:win # DEV
npm run start:win:prod # PROD

Mac:

npm run start:mac # DEV
npm run start:mac:prod # PROD

Unix:

npm run start:linux # DEV
npm run start:linux:prod # PROD

Running E2E (Cypress) Test

npm run cypress

Documentation

The documentation can be found in the root directory under the path documentation.

License

SPDX-License-Identifier: MPL-2.0

This program and the accompanying materials are made available under the terms of the Mozilla Public License, v. 2.0.

The Notice file details contained third party materials.

GraalVm native-image

To build a native image we use GraalVm: GraalVm