diff --git a/README.md b/README.md index 11f0287..b6d5bd9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,217 @@ -# FlashForgeWebUI -The WebUI from FlashForgeUI - Standalone. Designed for devices with limited resources +
+

FlashForge WebUI

+

Standalone WebUI for FlashForge 3D Printers

+
+ +

+ + + +

+ +
+

Overview

+
+ +
+ +FlashForge WebUI is a lightweight, standalone web interface for monitoring and controlling FlashForge 3D printers. Designed as a cross-platform alternative to desktop applications, it runs efficiently on low-spec hardware like the Raspberry Pi, making it perfect for dedicated print servers. It supports simultaneous connections to multiple printers, real-time camera streaming, and integrates seamlessly with Spoolman for filament management. + +
+ +
+

Core Features

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureDescription
Multi-Printer SupportConnect to and manage multiple printers simultaneously with isolated contexts
Live MonitoringReal-time tracking of temperatures, print progress, and printer status
Camera StreamingLow-latency video monitoring with RTSP and MJPEG support
Printer ControlFull control over print jobs (pause, resume, stop) and printer settings
Spoolman IntegrationNative integration for filament inventory and usage tracking
Responsive DashboardCustomizable grid-based UI that works on desktop, tablet, and mobile
Cross-PlatformNative binaries for Windows, macOS, and Linux (x64, ARM64, ARMv7)
+
+ +
+

Supported Printers

+
+ +
+ +FlashForge WebUI supports a wide range of FlashForge printers through its adaptable backend architecture. + +
+ +
+ + + + + + + + + + + + + + + + + + + + + +
SeriesModelsAPI Type
Adventurer 5MAdventurer 5M, 5M ProNew (HTTP API)
AD5XAD5XNew (HTTP API)
LegacyOlder FlashForge ModelsLegacy (FlashForgeClient)
+
+ +
+

Installation

+
+ +
+

Prerequisites

+
+ +
+ + + + + + + + + + + + + +
RequirementDetails
Node.jsVersion 20.0.0 or higher (for source installation)
NetworkConnection to your printer(s)
+
+ +
+ +**Running from Source** + +
+ +```bash +# Clone the repository +git clone https://github.com/Parallel-7/flashforge-webui.git +cd flashforge-webui + +# Install dependencies +npm install + +# Build the application +npm run build + +# Start the server +npm start +``` + +
+

Configuration

+
+ +
+ +The application automatically creates a configuration file at `data/config.json` on first run. You can modify this file to customize your experience. + +
+ +```json +{ + "WebUIEnabled": true, + "WebUIPort": 3000, + "WebUIPassword": "changeme", + "WebUIPasswordRequired": true, + "SpoolmanEnabled": false, + "SpoolmanServerUrl": "http://your-spoolman-instance:7912", + "CameraProxyPort": 8181 +} +``` + +
+

Development

+
+ +```bash +# Start development server with hot-reload +npm run dev + +# Build for specific platform +npm run build:linux +npm run build:win +npm run build:mac +``` + +
+

License

+
+ +
+ +MIT License + +
+ +
+

Acknowledgments

+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
ProjectRole
ff-5mp-api-tsFlashForge API Client Library
slicer-metaPrinter Metadata & Model Utilities
FlashForgeUI-ElectronOriginal Desktop Application
SpoolmanFilament Management
+