@arcanejs/react-toolkit 0.1.3 → 0.1.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 +25 -13
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/@arcanejs/react-toolkit)
|
|
4
4
|
|
|
5
5
|
`@arcanejs/react-toolkit` Allows you to quickly create real-time control panels
|
|
6
|
-
for your
|
|
6
|
+
for your single-process Node.js apps,
|
|
7
7
|
using a custom react renderer, and WebSockets.
|
|
8
8
|
|
|
9
9
|
Control panels can be accessed by any number of
|
|
@@ -18,20 +18,17 @@ but also works well with a cursor and keyboard.
|
|
|
18
18
|
<img src="./docs/architecture.svg" alt="Architecture Diagram">
|
|
19
19
|
</p>
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## What
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
and takes advantage of unstable `react` APIs exposed via `react-render`.
|
|
25
|
-
It's not suitable for production or commercial projects yet,
|
|
26
|
-
especially those that rely on regular updates of dependencies
|
|
27
|
-
for security reasons,
|
|
28
|
-
as usage of this project may make it difficult to keep `react` up-to-date
|
|
29
|
-
(that being said, the license does not prohibit this,
|
|
30
|
-
so feel free to at-your-own-risk).
|
|
23
|
+
- Easily create controller UIs for Node.js processes
|
|
31
24
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
25
|
+
- Uses server-side **React** for state management and UI composition
|
|
26
|
+
|
|
27
|
+
- This is not SSR, you can use `useState()` hooks etc...
|
|
28
|
+
|
|
29
|
+
- Instantly updates all clients using WebSockets
|
|
30
|
+
|
|
31
|
+
- Collection of 9+ components to build your UIs
|
|
35
32
|
|
|
36
33
|
## Why
|
|
37
34
|
|
|
@@ -291,3 +288,18 @@ TODO
|
|
|
291
288
|
For a comprehensive list of examples,
|
|
292
289
|
please see the example directory in the arcane monorepo:
|
|
293
290
|
<https://github.com/arcanejs/arcanejs/tree/main/examples/react>
|
|
291
|
+
|
|
292
|
+
## Status / Suitability / Security Disclaimer
|
|
293
|
+
|
|
294
|
+
This project is **experimental**,
|
|
295
|
+
and takes advantage of unstable `react` APIs exposed via `react-render`.
|
|
296
|
+
It's not suitable for production or commercial projects yet,
|
|
297
|
+
especially those that rely on regular updates of dependencies
|
|
298
|
+
for security reasons,
|
|
299
|
+
as usage of this project may make it difficult to keep `react` up-to-date
|
|
300
|
+
(that being said, the license does not prohibit this,
|
|
301
|
+
so feel free to at-your-own-risk).
|
|
302
|
+
|
|
303
|
+
There are also no authentication mechanisms implemented yet,
|
|
304
|
+
so be careful when exposing your control panels over the network,
|
|
305
|
+
as this will allow anyone to interact with your processes.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arcanejs/react-toolkit",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.4",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Build web-accessible control interfaces for your long-running Node.js processes",
|
|
6
6
|
"keywords": [
|
|
@@ -35,8 +35,8 @@
|
|
|
35
35
|
"react-reconciler": "^0.28.0",
|
|
36
36
|
"tsup": "^8.1.0",
|
|
37
37
|
"typescript": "^5.3.3",
|
|
38
|
-
"@arcanejs/
|
|
39
|
-
"@arcanejs/
|
|
38
|
+
"@arcanejs/typescript-config": "^0.0.0",
|
|
39
|
+
"@arcanejs/eslint-config": "^0.0.0"
|
|
40
40
|
},
|
|
41
41
|
"dependencies": {
|
|
42
42
|
"react": "^18",
|