Skip to content

Improve local development workflow/instructions#165

Merged
nsalminen merged 4 commits intogoogle:mainfrom
nsalminen:readme-instructions
Feb 14, 2026
Merged

Improve local development workflow/instructions#165
nsalminen merged 4 commits intogoogle:mainfrom
nsalminen:readme-instructions

Conversation

@nsalminen
Copy link
Collaborator

@nsalminen nsalminen commented Feb 13, 2026

The repo documentation contains some inconsistent instructions for running samples/demos and local development. Different READMEs reference different commands, including outdated ones like develop.sh. It is also not fully clear when to use a one-time build and serve workflow vs. watch-mode development.

This PR adds scripts for local development, introduces http-server as a development dependency, and aligns the README instructions. npm run dev is introduced as a new command to run both the new commands build:watch and serve. It also proposes making npm start an alias of npm run dev, as is common for SDKs, rather than limiting it to running rollup in watch mode.

I'm open to suggestions on how to improve this PR!

package.json Outdated
"dev": "concurrently \"npm:build:watch\" \"npm:serve\"",
"start": "npm run dev",
"build:watch": "rollup -c -w",
"serve": "http-server --cors -p 8080",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also add -a 127.0.0.1 so it's not listening any actual network interfaces?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dli7319 Ah of course! Done!

@nsalminen
Copy link
Collaborator Author

Will wait for @ruofeidu's review before merging for an extra check as it changes the main README and dev workflow.

This can be removed as 'npm install' already calls the build step automatically in 'prepare'
@ruofeidu
Copy link
Collaborator

Thank you Nels! LGTM!

-- I still owe you 3DGS asset --- will try getting done by next week :)

@nsalminen nsalminen merged commit a1dfa08 into google:main Feb 14, 2026
4 checks passed
@nsalminen nsalminen deleted the readme-instructions branch February 14, 2026 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants