Skip to content

README.md

Latest commit

 

History

History
125 lines (89 loc) · 2.45 KB

README.md

File metadata and controls

125 lines (89 loc) · 2.45 KB

index: demos

To use a given basic-demo as a template for a new myproject:

$ npx degit pmndrs/examples/demos/basic-demo myproject
$ code myproject

INSTALL

Prerequisites:

  • Install nvm, then:

    $ nvm install
$ nvm use
$ node -v # make sure your version satisfies package.json#engines.node

    nb: if you want this node version to be your default nvm's one: nvm alias default node

  • $ corepack enable
$ corepack prepare --activate # it reads "packageManager"
$ pnpm -v # make sure your version satisfies package.json#engines.pnpm
$ pnpm install

dev

$ pnpm run dev

build

$ pnpm run build

Then pnpm run start.

Details

This will:

  1. execute ^build2 which will vite build each demos/* with:
  • a --base set to ${BASE_PATH}/${app_name}
  • a custom vite --config, whith a monkey() plugin that will:
    • deterministic script into src/index.jsx
    • monkeypatch the <Canvas> with CheesyCanvas for setting up the scene for playwright screenshots
  1. build the Next.js apps/website
  2. copy final result into out folder

[!TIP] This is totally fine BASE_PATH/BASE_URL to be unset/empty. But for debug purposes(to be 1:1 with GitHub pages) you can:

$ BASE_PATH=/examples BASE_URL=http://localhost:4000 npm run build
$ npx serve out -p 4000

test

Important

Testing is WIP

$ pnpm test

To update the snapshots: pnpm test -- -- --update-snapshots

Details

You can also:

$ BASE_PATH=/examples pnpm test

Docker

For generating reproductible snapshots, we use mcr.microsoft.com/playwright:v1.45.3-jammy Docker image.

$ docker run -it --rm  \
  -w /app -v "$(pwd)":/app -v /app/node_modules \
  mcr.microsoft.com/playwright:v1.45.3-jammy /bin/sh
#
# echo "Hey, I am acting like the CI"
#
# corepack enable && pnpm install --frozen-lockfile
# pnpm test

or in one command to update snapshots:

docker run --rm  \
  -w /app -v "$(pwd)":/app -v /app/node_modules \
  mcr.microsoft.com/playwright:v1.45.3-jammy /bin/sh -c "corepack enable && pnpm install --frozen-lockfile && pnpm test -- -- --update-snapshots"

Colophon