https://github.com/eclipse-esmf/esmf-aspect-model-editor
Manage Aspect Models visually — create, validate, create artefacts, persist file based
https://github.com/eclipse-esmf/esmf-aspect-model-editor
Last synced: 5 months ago
JSON representation
Manage Aspect Models visually — create, validate, create artefacts, persist file based
- Host: GitHub
- URL: https://github.com/eclipse-esmf/esmf-aspect-model-editor
- Owner: eclipse-esmf
- License: mpl-2.0
- Created: 2022-03-23T20:23:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-02-03T13:11:45.000Z (5 months ago)
- Last Synced: 2026-02-03T20:55:13.202Z (5 months ago)
- Language: TypeScript
- Homepage: https://eclipse-esmf.github.io/ame-guide/introduction.html
- Size: 42.7 MB
- Stars: 23
- Watchers: 5
- Forks: 7
- Open Issues: 68
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS.md
- Notice: NOTICE.md
Awesome Lists containing this project
README
# Aspect Model Editor
## Table of Contents
- [Introduction](#introduction)
- [Getting help](#getting-help)
- [Getting started](#getting-started-for-developers)
- [Setup](#setup)
- [Install & Run](#install--run)
- [Run As Electron](#run-as-electron)
- [Running E2E (Cypress) Test](#running-e2e-cypress-test)
- [Documentation](#documentation)
- [License](#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](https://eclipse-esmf.github.io)
- Check the
SAMM [specification](https://eclipse-esmf.github.io/samm-specification/2.2.0/index.html)
- Having issues with the Aspect Model Editor? Open
a [GitHub issue](https://github.com/eclipse-esmf/esmf-aspect-model-editor/issues).
### 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](https://github.com/eclipse-esmf/esmf-aspect-model-editor-backend) first.
#### Setup
- Download & Install [Node.js](https://nodejs.org/en/download/)
- To generate Aspect Model documentation, the installation [GraphViz](https://graphviz.org/download) is required.
#### First steps into the code: [Code Overview](CODE-OVERVIEW.md)
#### Install & Run
```bash
# 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:
```bash
npm run start:win # DEV
npm run start:win:prod # PROD
```
Mac:
```bash
npm run start:mac # DEV
npm run start:mac:prod # PROD
```
Unix:
```bash
npm run start:linux # DEV
npm run start:linux:prod # PROD
```
#### Running E2E (Cypress) Test
```bash
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](LICENSE).
The [Notice file](NOTICE.md) details contained third party materials.
## GraalVm native-image
To build a native image we use GraalVm: [GraalVm](https://github.com/oracle/graal/tree/vm-ce-22.1.0)