Not sure how to get started developing locally

[bertday]

Hello!

I'm currently prototyping a new feature for MapLibre (an experimental new source type). I pulled down the repo, however I'm not seeing any documentation on how to build MapLibre locally, and I'm a bit confused by how it's working so far.

What I've tried is:

• npm run start
• Go to one of the examples (e.g. http://localhost:9966/examples/foo.html); it loads OK in the browser
• Edit and save a source file (e.g. src/source/source.ts)
• The dev server sees the change and rebuilds
• I refresh the example in the browser; changes do not appear / I'm getting served stale code
• I track down the stale code; it seems to be coming from staging/
• Delete staging/ and re-run npm run start
• I get an error: RollupError: Could not resolve "../../staging/maplibregl/shared" from "build/rollup/maplibregl.js"

I'm quite confused on what the role of the staging/ folder is and why I'm getting what seems to be not-quite-deterministic behavior from npm run start. That is, sometimes it seems to generate staging/ for me, but if I delete it it won't regenerate it?

I'm really excited to work on a potential new feature for MapLibre and it would be super helpful if anyone can straighten me out on how to get started. I would be happy to submit a PR once I know the ropes a bit better!

[zerda-ocm]

Have you tried npm run build-dev ?

[bertday]

Hi @zerda-ocm, thank you for the suggestion. I tried npm run build-dev and it runs successfully; however, when I try npm run start again, I get the same error I mentioned above:

[!] RollupError: Could not resolve "../../staging/maplibregl/shared" from "build/rollup/maplibregl.js"

[zerda-ocm]

I can't reproduce this error. I can start the server after a rebuild without any problems.

[zerda-ocm]

Oh, I forgot: I don't delete staging/ as I don't think it is necessary. Maybe it is just a caching problem within the browser?

[HarelM]

Staging is important, don't delete it.
Also, there are a lot readme files scattered works this repo with detailed information how to run all kinds of stuff.
If all this doesn't help you can take a look at the CI that is also defined in this repo.
npm run build-dist will build all what's needed to run everything.
Good luck!

[HarelM]

As for changing the code, make sure you refresh the browser and avoid cache issues as the names of the files don't change so browsers may cache the build artifacts.