Huly CEF

A Rust-based framework for building desktop applications using the Chromium Embedded Framework (CEF).

Overview

Huly CEF provides a set of Rust crates and tools for creating cross-platform desktop applications with web technologies. It includes WebSocket-based communication, instance management, and TypeScript client libraries.

Prerequisites

• Rust (latest stable version)
• Node.js and npm (for TypeScript client)
• Docker (optional, for running the manager in a container)

Project Structure

Crate Name	Description
huly-cef	Core library for interacting with the Chromium Embedded Framework (CEF)
huly-cef-helper	macOS-specific helper app required for proper bundle packaging
huly-cef-tools	Utility crate providing tools and helpers for building huly-cef apps
huly-cef-websockets	WebSocket-based server for streaming and interacting with CEF browser views
huly-cef-manager	A RESTful server that manages Huly CEF instances

Huly CEF Websockets

TODO: describe arguments

To build and run Huly CEF Websockets, use:

1. Build Huly CEF Websockets

   cargo run --bin huly-cef-build --release -- --profile release

2. Run Huly CEF Websockets
   Linux:

   ./target/release/huly-cef-websockets --cache-path cache/default

   Windows:

   ./target/release/huly-cef-websockets.exe --cache-path cache/default

   macOS:

   ./target/release/huly-cef-websockets.app/Contents/MacOS/huly-cef-websockets --cache-path cache/default

CEF Client (Development Only)

1. Build The Package
   To build the package, use the following command:

   cd ./packages/cef-client
   npm install
   npm run build

2. Link The Package
   To link the package, use the following command:

   npm link

3. Use The Package In Your Project
   To use the package in your project, run the following command in the project's folder:

   npm link cef-client

4. Publish The Package To publish the package, use the following command:

   npm publish