Skip to main content

What This Package Is

This package provides the create-elata-demo CLI and the templates behind:
  • rppg-web-demo
  • eeg-web-demo
  • eeg-web-ble-demo
Short aliases are also supported:
  • rppg
  • eeg
  • eeg-ble
Use it when you want a clean demo app or a consumer-facing reference project.

When To Use It

Use this package when you want:
  • the fastest path to a working Elata app
  • a reference project that matches the published package surface
  • a known-good baseline before integrating packages into an existing app
Do not start with repo-internal demos when this package already covers your use case.

Install And Invocation

This package is usually invoked without installing it permanently:
npm create @elata-biosciences/elata-demo my-app
pnpm dlx @elata-biosciences/create-elata-demo my-app
npx @elata-biosciences/create-elata-demo my-app

Requirements

  • Node.js >= 18

Template Listing

pnpm dlx @elata-biosciences/create-elata-demo -- --list-templates
npx @elata-biosciences/create-elata-demo -- --list-templates
# rPPG web demo
npm create @elata-biosciences/elata-demo my-app

# EEG web demo
npm create @elata-biosciences/elata-demo my-app -- --template eeg-web-demo

# EEG web demo (alias)
npm create @elata-biosciences/elata-demo my-app -- --template eeg

# EEG Web Bluetooth demo
npm create @elata-biosciences/elata-demo my-app -- --template eeg-web-ble-demo

# EEG Web Bluetooth demo (alias)
npm create @elata-biosciences/elata-demo my-app -- --template eeg-ble
When the CLI is run interactively without --template, it prompts you to pick a template. In non-interactive runs, it still falls back to rppg-web-demo.

What You Get

Each generated app includes:
  • a minimal Vite + React app shell
  • Elata packages pinned to a compatible set of versions
  • a template-specific README.md
  • a buildable project you can use as a comparison baseline later

Workspace Caveat

If you scaffold a new app inside another pnpm workspace and that app is not added to the workspace globs, run this from the parent directory:
pnpm --dir my-app --ignore-workspace install
pnpm --dir my-app --ignore-workspace run dev
Or use npm install and npm run dev inside the generated app.

Repo Verification

The package is tested from the repo with:
pnpm --dir packages/create-elata-demo test
./run.sh test create-elata-demo
The second command also smoke-tests each template by scaffolding, installing dependencies, and running a build.