Merge pull request #1 from wavelet-lab/develop

Add WASM-based SDR control library and integration with supported devices

Author: dtv-comp

README.md

@@ -0,0 +1,90 @@
+# WebSDR
+
+[WebSDR](https://github.com/wavelet-lab/websdr) is an open-source TypeScript monorepo that provides libraries and tools for building web applications that work with Software Defined Radios (SDR) using WebUSB and related browser/node tooling.
+
+⚠️ This project is under active development. Some features are experimental and APIs may change.
+
+## What is WebSDR?
+
+WebSDR contains utilities, UI components, backend modules, and small test apps to make it easier to build browser-based SDR applications and tooling. The primary goal is to enable interaction with SDR devices connected over USB from web applications (via WebUSB), and to provide supporting building blocks for dashboards, demos, and server-side microservices.
+
+Core capabilities include:
+- WebUSB device management (requesting devices, selecting devices in UI components).
+- A small Vue 3 component library for dashboards and controls (dropdowns, lists, inputs, log viewers).
+- NestJS modules for microservices (authentication, API scaffolding) useful for backend parts of an SDR web platform.
+- Utility modules: circular buffers, data conversion helpers, string utilities, time helpers and promise helpers used across frontend and backend.
+
+## Repository layout
+
+Top-level structure (important folders):
+
+```
+packages/
+├─ core/                # Shared domain types, utilities, constants
+├─ frontend-core/       # Front-end utilities and WebUSB adapters
+├─ vue3-components/     # Reusable Vue 3 UI components and styles
+├─ nestjs-microservice/ # NestJS modules (auth, API helpers, microservice wiring)
+test-apps/              # Small example/test applications and scripts
+```
+
+Brief package descriptions:
+- `packages/core` — Core shared library with domain types, utilities, constants and radio-related helpers.
+- `packages/frontend-core` — Front-end core utilities, WebUSB adapters, and services used by client apps.
+- `packages/vue3-components` — Vue 3 component library (examples: `SdrInput`, `Dropdown`, `List`, `LogArea`). Built with Vite; ships TypeScript types and styles.
+- `packages/nestjs-microservice` — NestJS integration and helper modules; main entry is `WebSDRModule` (configurable via environment variables such as `WEBSDR_*`).
+- `test-apps` — Small scripts and demo pages used to test low-level functionality (e.g., `usb-test.ts`).
+
+## Quick setup
+
+Install dependencies for the workspace:
+
+```bash
+npm install
+```
+
+Build the packages:
+
+```bash
+npm run build
+```
+
+Run tests (runs workspace tests):
+
+```bash
+npm run test
+```
+
+Run all tests
+```bash
+npm run test:all
+```
+
+Run all tests and watch for changes
+```bash
+npm run test:watch
+```
+
+Run coverage check
+```bash
+npm run test:coverage
+```
+
+## Running test applications
+
+Example test apps live in `test-apps`. To run them:
+
+```bash
+cd test-apps
+npm install
+npm run test:usb   # runs the USB test script (requires appropriate permissions/flags)
+```
+
+Note: WebUSB requires HTTPS or localhost and browser support. Running tests that access USB devices may require additional browser flags or permissions.
+
+## Environment / Configuration
+
+- `packages/nestjs-microservice` reads configuration from environment variables (prefixed with `WEBSDR_` in places). See the module entry and code for exact variable names.
+
+## License
+
+WebSDR is [MIT licensed](https://github.com/wavelet-lab/websdr/blob/main/LICENSE)