@apocaliss92/nodelink-js 0.1.8 → 0.1.14

package/README.md

@@ -1,6 +1,12 @@
-# @apocaliss92/nodelink-js
-
-A TypeScript library for interacting with Reolink IP cameras and NVRs using the proprietary Baichuan protocol and CGI API.
+<table>
+  <tr>
+    <td><img src="app/client/public/icon-512x512.png" alt="nodelink.js" width="256" height="256"></td>
+    <td>
+      <h1>nodelink.js</h1>
+      <p>A TypeScript library for interacting with Reolink IP cameras and NVRs using the proprietary Baichuan protocol and CGI API.</p>
+    </td>
+  </tr>
+</table>
 
 ## Credits
 
@@ -24,6 +30,75 @@ This library is inspired by and based on the reverse engineering work done by:
 
 ---
 
+## 🖥️ Manager UI (Web Dashboard)
+
+The library includes a **complete web-based management interface** for easy camera configuration and streaming control without writing code.
+
+<p align="center">
+  <b>Features:</b>
+</p>
+
+- 🎛️ **Camera Management** - Add, configure, and monitor multiple cameras
+- 📹 **Live Streaming** - Preview streams via MJPEG, WebRTC, or RTSP
+- 📊 **Real-time Logs** - Monitor camera events and system logs
+- ⚙️ **Settings** - Configure RTSP proxy, ports, and auto-start options
+- 📱 **PWA Support** - Install as a Progressive Web App on mobile devices
+- 🌐 **Responsive Design** - Works on desktop, tablet, and mobile
+
+### Quick Start (Development)
+
+```bash
+cd app
+npm install
+npm run dev
+```
+
+- Web UI: http://localhost:5173
+- API Server: http://localhost:3000
+
+### Production Build
+
+```bash
+cd app
+npm run build
+npm start
+```
+
+Open http://localhost:3000 in your browser.
+
+### Docker Deployment (Recommended)
+
+The easiest way to run the Manager UI is with Docker:
+
+```bash
+# Using pre-built image
+docker pull ghcr.io/apocaliss92/nodelink-manager:latest
+
+docker run -d \
+  --name nodelink-manager \
+  --network host \
+  -v nodelink-data:/data \
+  ghcr.io/apocaliss92/nodelink-manager:latest
+```
+
+Or with Docker Compose:
+
+```bash
+docker-compose up -d
+```
+
+**Environment Variables:**
+
+| Variable    | Default | Description                          |
+| ----------- | ------- | ------------------------------------ |
+| `PORT`      | `3000`  | HTTP server port                     |
+| `RTSP_PORT` | `8554`  | RTSP proxy port                      |
+| `DATA_PATH` | `/data` | Directory for settings.json and logs |
+
+📖 **[Full Docker documentation →](./DOCKER.md)**
+
+---
+
 ## 📚 Full API Documentation
 
 For detailed method-by-method documentation, see the [documentation](./documentation/) folder:
@@ -381,10 +456,7 @@ CAMERA_PASSWORD=your-password
 The library supports custom loggers:
 
 ```typescript
-import {
-  ReolinkBaichuanApi,
-  createLogger,
-} from "@apocaliss92/nodelink-js";
+import { ReolinkBaichuanApi, createLogger } from "@apocaliss92/nodelink-js";
 
 const logger = createLogger({ level: "debug" });
 

package/dist/{DiagnosticsTools-MTXG65O3.js → DiagnosticsTools-YEML4E5V.js}

@@ -9,7 +9,7 @@ import {
   runMultifocalDiagnosticsConsecutively,
   sampleStreams,
   testChannelStreams
-} from "./chunk-MC2BRLLE.js";
+} from "./chunk-QEA2V52E.js";
 export {
   collectCgiDiagnostics,
   collectMultifocalDiagnostics,
@@ -22,4 +22,4 @@ export {
   sampleStreams,
   testChannelStreams
 };
-//# sourceMappingURL=DiagnosticsTools-MTXG65O3.js.map
+//# sourceMappingURL=DiagnosticsTools-YEML4E5V.js.map