@openrfid/shell 0.1.0 → 1.0.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 +67 -0
- package/package.json +9 -8
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<img src="https://raw.githubusercontent.com/rfidsoftwares/openrfid-simulator/main/assets/logo.svg" alt="OpenRFID Simulator Logo" width="180" />
|
|
4
|
+
|
|
5
|
+
# `@openrfid/shell`
|
|
6
|
+
|
|
7
|
+
### Cross-Platform Desktop & Web Integration Orchestration Shell
|
|
8
|
+
|
|
9
|
+
[](https://www.npmjs.com/package/@openrfid/shell)
|
|
10
|
+
[](https://opensource.org/licenses/MIT)
|
|
11
|
+
[](https://rfidsoftwares.com)
|
|
12
|
+
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 🚀 Overview
|
|
18
|
+
|
|
19
|
+
`@openrfid/shell` provides cross-platform application bootstrapping, IPC communication bridges, and process orchestration for embedding **OpenRFID Simulator** into Tauri desktop apps or browser-based SPA environments.
|
|
20
|
+
|
|
21
|
+
Developed & Maintained by **[RFID Software India Private Limited](https://rfidsoftwares.com)**.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 📦 Installation
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
# npm
|
|
29
|
+
npm install @openrfid/shell
|
|
30
|
+
|
|
31
|
+
# pnpm
|
|
32
|
+
pnpm add @openrfid/shell
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## 💻 Code Example
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
import { ApplicationShell } from '@openrfid/shell';
|
|
41
|
+
|
|
42
|
+
const shell = new ApplicationShell({
|
|
43
|
+
mode: 'desktop', // 'desktop' (Tauri) or 'web' (Vite)
|
|
44
|
+
enableSidecar: true
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
await shell.bootstrap();
|
|
48
|
+
console.log('OpenRFID Application Shell initialized.');
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## 🌐 Monorepo Ecosystem
|
|
54
|
+
|
|
55
|
+
| Package | Description |
|
|
56
|
+
| :--- | :--- |
|
|
57
|
+
| [`@openrfid/ui`](https://www.npmjs.com/package/@openrfid/ui) | Shared React component library |
|
|
58
|
+
| [`@openrfid/simulator`](https://www.npmjs.com/package/@openrfid/simulator) | High-throughput inventory simulation engine |
|
|
59
|
+
| [`@openrfid/core`](https://www.npmjs.com/package/@openrfid/core) | Core EventBus, Config, & SQLite persistence |
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## 📄 License & Corporate Support
|
|
64
|
+
|
|
65
|
+
Licensed under the **MIT License**.
|
|
66
|
+
Brought to you by **RFID Software India Private Limited**.
|
|
67
|
+
For enterprise RFID middleware, hardware drivers, or custom protocol plugins, visit **[rfidsoftwares.com](https://rfidsoftwares.com)**.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openrfid/shell",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "Shared React views shell for OpenRFID Simulator.",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -13,17 +13,18 @@
|
|
|
13
13
|
}
|
|
14
14
|
},
|
|
15
15
|
"files": [
|
|
16
|
-
"dist"
|
|
16
|
+
"dist",
|
|
17
|
+
"README.md"
|
|
17
18
|
],
|
|
18
19
|
"dependencies": {
|
|
19
20
|
"react": "^18.2.0",
|
|
20
21
|
"react-dom": "^18.2.0",
|
|
21
|
-
"@openrfid/core": "
|
|
22
|
-
"@openrfid/
|
|
23
|
-
"@openrfid/
|
|
24
|
-
"@openrfid/
|
|
25
|
-
"@openrfid/
|
|
26
|
-
"@openrfid/
|
|
22
|
+
"@openrfid/core": "1.0.0",
|
|
23
|
+
"@openrfid/plugin-api": "1.0.0",
|
|
24
|
+
"@openrfid/simulator": "1.0.0",
|
|
25
|
+
"@openrfid/readers": "1.0.0",
|
|
26
|
+
"@openrfid/tags": "1.0.0",
|
|
27
|
+
"@openrfid/ui": "1.0.0"
|
|
27
28
|
},
|
|
28
29
|
"devDependencies": {
|
|
29
30
|
"@types/react": "^18.2.66",
|