Nuxt Layer Starter

Create Nuxt extendable layer with this GitHub template.

Setup

Make sure to install the dependencies:

pnpm install

Working on your layer

Your layer is at the root of this repository, it is exactly like a regular Nuxt project, except you can publish it on NPM.

The .playground directory should help you on trying your layer during development.

Running pnpm dev will prepare and boot .playground directory, which imports your layer itself.

Distributing your layer

Your Nuxt layer is shaped exactly the same as any other Nuxt project, except you can publish it on NPM.

To do so, you only have to check if files in package.json are valid, then run:

npm publish --access public

Once done, your users will only have to run:

npm install --save your-layer

Then add the dependency to their extends in nuxt.config:

defineNuxtConfig({
  extends: 'your-layer'
})

Development Server

Start the development server on http://localhost:3000

pnpm dev

Production

Build the application for production:

pnpm build

Or statically generate it with:

pnpm generate

Locally preview production build:

pnpm preview

Checkout the deployment documentation for more information.

HERO robot rules for the mobile apps

utils/robot-display.ts is the canonical home of the HERO robot display rules. The React Native apps (iClean365, iMA365, iSecure365) cannot consume this layer and no separate npm package is published for them, so scripts/sync-robot-rules.mjs writes a dependency-free copy into each app (src/shared/robot-rules/robot-rules.ts, GENERATED, with a sha256 header) plus robot-rules.vectors.json - this repo's own answers for every case. Each app's test re-hashes the copy and runs the vectors, so a hand edit fails there.

After changing utils/robot-display.ts (or the lift-queue section of utils/robot-building.ts, or HERO_PALETTE in utils/theme.ts):

node scripts/sync-robot-rules.mjs ../iservice365-hygiene-mobile-app ../iservice365-ma-mobile-app ../isecure365-mobile-app
node scripts/sync-robot-rules.mjs --check ../iservice365-hygiene-mobile-app ../iservice365-ma-mobile-app ../isecure365-mobile-app

and open a PR in each app with the two regenerated files. test/robot-rules-sync.test.mjs checks the generator here. The script is not part of the published package.