digitaltwin-core 0.4.1 → 0.5.0
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 +20 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@ Digital Twin Core is a minimalist TypeScript framework used to collect and proce
|
|
|
4
4
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
7
|
-
- **Collectors**
|
|
7
|
+
- **Collectors** - fetch regular data from APIs (typically JSON) based on a Buffer schedule, store it and expose it via GET endpoints.
|
|
8
8
|
- **Harvesters** – transform data collected by collectors, store the results and expose them via GET endpoints.
|
|
9
9
|
- **Handlers** – expose GET endpoints that directly return the result of the method defined in the decorator.
|
|
10
10
|
- **Assets Manager** – upload, store and manage file assets with metadata, providing RESTful endpoints for CRUD operations.
|
|
@@ -110,6 +110,25 @@ class GLTFAssetsManager extends AssetsManager {
|
|
|
110
110
|
}
|
|
111
111
|
```
|
|
112
112
|
|
|
113
|
+
## Project Scaffolding
|
|
114
|
+
|
|
115
|
+
Use [create-digitaltwin](https://github.com/CePseudoBE/create-digitaltwin) to quickly bootstrap new projects:
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
npm init digitaltwin my-project
|
|
119
|
+
cd my-project
|
|
120
|
+
npm install
|
|
121
|
+
npm run dev
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
Generated projects include [digitaltwin-cli](https://github.com/CePseudoBE/digitaltwin-cli) for component generation:
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
node dt make:collector WeatherCollector --description "Weather data collector"
|
|
128
|
+
node dt make:handler ApiHandler --method post
|
|
129
|
+
node dt make:harvester DataProcessor --source weather-collector
|
|
130
|
+
```
|
|
131
|
+
|
|
113
132
|
## Folder structure
|
|
114
133
|
|
|
115
134
|
- `src/` – framework sources
|