Skip to main content

Getting Started

Clone the repository normally:

git clone https://github.com/neelsani/openipc-rs
cd openipc-rs

Test The Core​

cargo test -p openipc-core

Build The WASM SDK​

npm --prefix crates/openipc-web run build

The generated package is written to crates/openipc-web/pkg. It is not checked into git.

Run OpenIPC Station In The Browser​

cd apps/openipc-station
npm install
npm run dev

Build the deployable browser/WebUSB version:

npm run build

Deploy that build to Cloudflare Workers:

npm run deploy:worker

Run OpenIPC Station As A Desktop App​

cd apps/openipc-station
npm install
npm run desktop:dev

The desktop app uses the same React UI as the browser build, but USB receive and transmit run through native Rust instead of browser WebUSB.

Build This Documentation Site​

cd docs
npm install
npm run build