@things-factory/operato-board 10.0.0-beta.98 → 10.0.0-y.0

package/README.md

@@ -1,99 +1,151 @@
-![Data Analytics Dashboard](https://source.unsplash.com/1600x900/?data,analytics,dashboard)
+![Operato Board](https://source.unsplash.com/1600x900/?digital,twin,factory)
 
-## Operato Board
+# Operato Board
 
-- Operato : Solution family brand of hatiolab.com(http://www.hatiolab.com)
-- Board : Monitoring Solution
+> **A Zero-to-Twin canvas** — assemble a live, simulating digital twin from visual building blocks with near-zero external code, then drive it with real-time monitoring.
 
-## prerequisites
+`@things-factory/operato-board` is the production application of the `things-factory` platform that hosts the board modeler & viewer, the scene component runtime, and the real-time data backbone needed to author and operate digital twins.
 
-- nodejs version 12
+## What you can build
 
-## build
+- **Live dashboards & SCADA-style panels** — chart, gauge, table, gantt, sensor, news ticker, …
+- **Factory / logistics digital twins** — conveyor lines, transports, racks, AGV, port, crane, …
+- **3D / mixed-reality scenes** — IFC building models, URDF robots, 3D visualizer
+- **Geospatial views** — Google Map, indoor map, polypath
+- **Custom integrations** — GraphQL, RESTful, InfluxDB, OpenAI, MS Graph, weather, KR Juso/Data.go.kr, …
 
-```
-$ yarn install && yarn upgrade
+All of the above are plug-in *scene components*: drop them onto a board, wire them with bindings, and they animate, render, and respond to live data without writing application code.
+
+## Key features
+
+- **Visual modeler** — drag-and-drop board authoring with property panels, layers, and bindings
+- **Multi-mode runtime** — same board renders as a flat dashboard or a 3D world depending on viewer mode
+- **Embedded simulation** — carriers, transports, and flow logic can be simulated in-place for design-time validation
+- **Real-time data** — push subscriptions over GraphQL, polling integrations, and offline-capable client cache
+- **Auth & licensing** — domain-scoped accounts, Azure AD / Google SSO, host-bound license enforcement
+- **Internationalization** — built-in i18n for both authoring UI and runtime scenes
+- **Extensible** — `@operato/scene-*` packages register components through a `sceneComponent` decorator; add your own without forking
+
+## Tech stack
+
+| Layer | Stack |
+|---|---|
+| Language | TypeScript |
+| UI | Web Components + LitElement |
+| Graphics | `@hatiolab/things-scene` (canvas + WebGL/Three) |
+| Backend | Node.js · `@things-factory/shell` (Express) · TypeORM |
+| API | GraphQL (primary) · RESTful (fallback) |
+| Auth | Passport + JWT · Google · Azure AD |
+| Build | Webpack 5 · Lerna · Yarn workspaces |
+
+## Prerequisites
+
+- Node.js **20 LTS** or later
+- Yarn (Classic, v1.x)
+- A supported database (PostgreSQL recommended; SQLite works for development)
+
+## Develop
+
+```bash
+yarn install
+yarn serve:dev
 ```
 
-## run
+Then open <http://localhost:3000> and sign in with the seeded admin account:
 
+- id: `admin@hatiolab.com`
+- password: `admin`
+
+## Build
+
+```bash
+yarn build          # build server + client
+yarn build:app      # build a deployable webpack bundle
 ```
-$ yarn serve:dev
+
+## Production install
+
+Use the provided installer to download and lay out a release into a target folder:
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/things-factory/things-factory/master/packages/operato-board/installer/install.sh | bash -s
 ```
 
-## browser
+This produces:
 
-- http://localhost:3000
-- login with id/password (admin@hatiolab.com / admin)
+| Script | Purpose |
+|---|---|
+| `start.sh [port]` | Start the application (defaults to port 4000) |
+| `stop.sh` | Stop a running instance |
+| `migrate.sh` | Run database migrations (required on first start) |
 
-## install
+First-time setup:
 
-- operato-board installation script
+```bash
+./start.sh
+./migrate.sh
+./stop.sh
+./start.sh 80
+```
 
-  - create a folder for the application and change directory to your folder.
-  - the script will download a& install operato-board
+## Docker
 
-    ```
-    # install script for operato-board
-    curl -fsSL https://raw.githubusercontent.com/things-factory/things-factory/master/packages/operato-board/installer/install.sh | bash -s
-    ```
+Pre-built images are published to Docker Hub:
 
-  - run 'start.sh' to start operato-board and 'stop.sh' to stop the running applicaton.
-  - on initial start, run 'migrate.sh' first to migrate database.
+```bash
+# pull & run the latest amd64 image on host port 4000
+docker run --platform linux/amd64 -p 4000:3000 hatiolab/operato-board:latest
+```
 
-  ```
-  # data migration
-  $ ./start.sh
-  $ ./migrate.sh
-  $ ./stop.sh
+Build locally:
 
-  # restart with service port no. defualt uses 4000
-  $ ./start.sh 80
-  ```
+```bash
+yarn docker          # amd64
+yarn docker:arm      # arm64
+yarn docker:cn       # mainland-China mirror variant
+```
 
 ## License
 
-### License request process
-
-Edit bellowing data and send request to license manager(syj0130@hatiolab.com)
-
-- **Product Type** : Things or Operato
-- **License Type** : Production or Evaluation
-- **Purchase Date** : License purchased date
-- **Expiration Date** : License expiration Date
-- **Host Address** : host or UNLIMITED
-  host can be
-  - host: sub.scond-level.top-level
-    > ex) board.hatiolab.com, \*.hatiolab.com
-  - ip :
-    > ex) 192.168.1.9, 192.168.\*.\*,
-- **Max Target(Board) Count**
-  - Board count by domain
-  - 0 means unlimited
-- **Max Domain Count**
-  - Max domain count in this host
-  - 0 means unlimited
-
-### license format
+Operato Board is shipped under the **MIT License**, but production deployments are gated by a host-bound license key.
+
+### Requesting a license
+
+Email the following to the license manager at <syj0130@hatiolab.com>:
+
+- **Product Type** — `Things` or `Operato`
+- **License Type** — `Production` or `Evaluation`
+- **Purchase Date / Expiration Date**
+- **Host Address** — hostname, IP, wildcard (e.g. `*.hatiolab.com`, `192.168.*.*`), or `UNLIMITED`
+- **Max Target (Board) Count** — `0` = unlimited
+- **Max Domain Count** — `0` = unlimited
+
+### License file format
 
 ```json
 {
   "License Type": "Evaluation",
-  "Purchase Date": "2021.03.23",
-  "Expiration Date": "2021.06.30",
+  "Purchase Date": "2026.01.01",
+  "Expiration Date": "2026.12.31",
   "Host Address": "UNLIMITED",
   "Max Target Count": 0,
   "Max Domain Count": 0,
-  "Key": ""
+  "Key": "<issued-key>"
 }
 ```
 
-### import license
+### Wiring the license
 
 ```js
-var licenseKey = require('./license').Key // import license file
+const licenseKey = require('./license').Key
+
 module.exports = {
   accessTokenCookieKey: 'access_token.board',
-  licenseKey: licenseKey // put license key value to here
+  licenseKey
 }
 ```
+
+## Links
+
+- Hatiolab — <https://www.hatiolab.com>
+- things-factory platform — <https://github.com/hatiolab/things-factory>

package/_index.html

@@ -3,10 +3,10 @@
   <head>
     <meta charset="utf-8" />
     <meta name="google" content="notranslate" />
-    <title>Operato Board</title>
+    <title>Operato Board · Zero-to-Twin</title>
     <meta name="generator" content="Things Factory Starter Kit" />
     <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no, viewport-fit=cover" />
-    <meta name="description" content="Things Board Micro-Module Edition" />
+    <meta name="description" content="Zero-to-Twin." />
 
     <base href="/" />
 
@@ -21,13 +21,13 @@
     <!-- Add to homescreen for Chrome on Android. Fallback for manifest.json -->
     <meta name="mobile-web-app-capable" content="yes" />
     <meta name="application-name" content="Operato Board" />
-    <meta name="application-description" content="Reimagining Visualization" />
+    <meta name="application-description" content="Zero-to-Twin." />
     <meta name="application-copyright" content="Copyright © hatiolab.com. All Rights Reserved." />
     <link rel="application-icon" href="/assets/manifest/icon-96x96.png" />
 
     <!-- Add to homescreen for Safari on iOS -->
     <meta name="apple-mobile-web-app-capable" content="yes" />
-    <meta name="apple-mobile-web-app-status-bar-style" content="default" />
+    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
     <meta name="apple-mobile-web-app-title" content="Operato Board" />
 
     <!-- Homescreen icons -->
@@ -42,20 +42,16 @@
     <meta name="msapplication-TileColor" content="#897067" />
     <meta name="msapplication-tap-highlight" content="no" />
 
-    <!-- Default twitter cards -->
+    <!-- Open Graph / Twitter cards -->
     <meta name="twitter:card" content="summary" />
-    <meta name="twitter:site" content="@username" />
     <meta property="og:type" content="website" />
-    <meta property="og:site_name" content="things-board" />
+    <meta property="og:site_name" content="Operato Board" />
     <meta property="og:image" content="assets/manifest/icon-144x144.png" />
 
-    <!-- Performance tip: hint to the browser to start the handshake for the fonts site -->
-    <link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin />
     <link href="/node_modules/material-symbols/index.css" rel="stylesheet" />
     <link href="/node_modules/@fontsource/roboto/index.css" rel="stylesheet" />
     <link rel="stylesheet" href="/theme.css" />
 
-    <!-- Global site tag (gtag.js) - Google Analytics -->
     <script src="/static/index.js" defer></script>
   </head>
   <body class="light">
@@ -63,7 +59,5 @@
     <noscript> Please enable JavaScript to view this website. </noscript>
     <!-- Load webcomponents-loader.js to check and load any polyfills your browser needs -->
     <script src="/node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js"></script>
-
-    <!-- Built with love using PWA Starter Kit -->
   </body>
 </html>