The <model-viewer> project

This is the main Github repository for the <model-viewer> web component and all of its related projects.

The repository is organized into sub-directories containing the various projects. Check out the README.md files for specific projects to get more details:

👩‍🚀 <model-viewer> • The <model-viewer> web component (probably what you are looking for)

🌐 modelviewer.dev • The source for the <model-viewer> documentation website

🖼 render-fidelity-tools • Tools for testing how well <model-viewer> renders models

🎨 shared-assets • 3D models, environment maps and other assets shared across many sub-projects

Installing <model-viewer>

The <model-viewer> web component can be installed from NPM:

npm install @google/model-viewer

It can also be used from various free CDNs such as unpkg.com:

<script type="module" src="https://unpkg.com/@google/model-viewer/dist/model-viewer.js"></script>
<script nomodule src="https://unpkg.com/@google/model-viewer/dist/model-viewer-legacy.js"></script>

For more detailed usage documentation and live examples, please visit our docs at modelviewer.dev!

Development

When developing across all the projects in this repository, first install git, Node.js and npm.

Then, perform the following steps to get set up for development:

git clone git@github.com:GoogleWebComponents/model-viewer.git
cd model-viewer
npm install
npm run bootstrap

The following global commands are available:

Command	Description
npm run bootstrap	Bootstraps the project for development and cross-links sub-projects
npm run build	Runs the build step for all sub-projects
npm run build:legacy-support	Builds JS bundles that have IE11 support
npm run serve	Runs a web server and opens a new browser tab pointed to the local copy of modelviewer.dev (don't forget to build!)
npm run test	Runs tests in all sub-projects that have them
npm run clean	Removes built artifacts from all sub-projects

You should now be ready to work on any of the <model-viewer> projects!