pixiv/three-vrm

`CONTRIBUTING.md` development instructions missing build step

mattrossman opened this issue · 2 comments

I am trying to set up this project for local development.

I read the "How to develop" section in CONTRIBUTING.md:

## How to develop
The below should work:
```sh
yarn
cd packages/three-vrm
yarn dev
```

When I run the steps shown and open http://localhost:10001/examples/ I see the examples page, but when I open one such as basic.html, I get an import error in the console:

❌ Uncaught TypeError: Failed to resolve module specifier "@pixiv/three-vrm-materials-mtoon". Relative references must start with either "/", "./", or "../".

I also see some warnings in the terminal:

image

It seems the instructions should include a yarn build step after the initial yarn install:

yarn 
yarn build
cd packages/three-vrm 
yarn dev 

That allows me to run the examples properly.

0b5vr commented

That is true, we have to rearrange the yarn scripts.

Thank you for the workaround steps.

0b5vr commented

ahh, I just noticed that simply running yarn does not build submodules in the first place. thank you!