@digital-enabler/demf-dtm-relations-editor 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +67 -0
- package/app.js +50 -0
- package/app.js.map +1 -0
- package/package.json +73 -0
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# demf-dtm-relations-editor
|
|
2
|
+
|
|
3
|
+
Digital Enabler Relations Editor microfrontend
|
|
4
|
+
|
|
5
|
+
### Digital Enabler - Digital Twin Relations Editor microfrontend
|
|
6
|
+
|
|
7
|
+
The Digital Twin Relations Editor microfrontend allows you to visually create, edit, and manage relationships between digital twin models. It is designed to be used within the Digital Twin Manager (DTM) tool and can be integrated as a microfrontend in the Digital Enabler platform.
|
|
8
|
+
|
|
9
|
+
> NOTE: See [root-config-template](https://github.com/digital-enabler/root-config-template) for how to mount a microfrontend and also [vuejs-microfrontend-template](https://github.com/digital-enabler/vuejs-microfrontend-template/blob/main/README.md#vue-js-template-project-with-vuecli-v4515) for more info about Microfrontend applications for Digital Enabler.
|
|
10
|
+
|
|
11
|
+
This project is also available from the following [CDN](https://cdn.jsdelivr.net/npm/@digital-enabler/demf-dtm-relations-editor@latest/app.js).
|
|
12
|
+
|
|
13
|
+
## Pre-requisites
|
|
14
|
+
|
|
15
|
+
Before you continue you need to:
|
|
16
|
+
|
|
17
|
+
- have [NPM](https://www.npmjs.com/) installed
|
|
18
|
+
- have [NodeJS](https://nodejs.org/) installed
|
|
19
|
+
- have [VueJS](https://v2.vuejs.org/v2/guide/) and [Vue-CLI](https://cli.vuejs.org/guide/installation.html) installed
|
|
20
|
+
- have a [GitHub](https://github.com/) account
|
|
21
|
+
- use VisualStudio Code or IntelliJ Idea as your development IDE
|
|
22
|
+
|
|
23
|
+
## Project management
|
|
24
|
+
|
|
25
|
+
### Installation
|
|
26
|
+
|
|
27
|
+
Open a **Terminal** window in the project folder and go inside the app folder, then launch the command:
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
npm install
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
> NOTE: When install finished, do not care about the warnings on the versions and vulnerability problems reported, and DO NOT launch the `npm audit fix` or `npm audit fix –force` commands
|
|
34
|
+
|
|
35
|
+
### Compiles and hot-reloads for development
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
npm run serve
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Compiles and minifies for production
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
npm run build
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Lints and fixes files
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
npm run lint
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
> NOTE: Alternatively to the command indicated above you can use the VueUI browser interface
|
|
54
|
+
|
|
55
|
+
## Configs file
|
|
56
|
+
|
|
57
|
+
To work properly the Relations Editor needs a _dtm-relations-editor-config.json_ file with these settings:
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"mf": "Digital Twin Relations Editor",
|
|
62
|
+
"api": "https://[generic_api_location]/api",
|
|
63
|
+
"storageImgs": "https://[assets_storage_url]/imgs"
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
This json file must be stored and set as described [here](https://github.com/digital-enabler/vuejs-microfrontend-template#vue-js-template-project-with-vuecli-v4515) and also [here](https://github.com/digital-enabler/root-config-template#root-config-template).
|