This project is set up as a monorepo. The SDK is split into multiple packages, located inside the /packages directory.
-
NodeJS LTS
- Prefer using
nvmon dev machines:
nvm install --lts nvm use --lts
- Prefer using
-
pnpm- alternative package manager to
npm - easiest to install using
npm install -g pnpm - alternative installation methods
- alternative package manager to
Install packages:
pnpm installInstall necessary conan packages:
pnpm conan-installRun the build process, this will configure and build all the packages in the monorepo:
pnpm buildTo run an example app, navigate to any of the examples in /apps/ and run:
pnpm devTo run the app on your local network use:
pnpm dev --hostTo run the example apps, you will need a licence key and place it in the .env file.
Additionally, each package can be built individually by navigating to its folder and running the corresponding scripts.
Published packages can be found here: