nRF Guide Protocols

Documents the communication protocol between the nRF Guide backend and the web application.

Usage

npm i --save-exact @nrf-guide/proto

Example

Setup

Fetch the submodules

git submodule init
git submodule update --remote

Install the dependencies:

npm ci

Run tests

npm test

Update generated code

npx tsx generate/types/schema-to-type.ts
npx tsx generate/schema/NRFCloudMessage.schema.ts
npx prettier --write .