Files
speckle-server/packages/viewer

The Speckle Viewer

Twitter Follow Community forum users website docs npm version

Disclaimer

We're working to stabilize the 2.0 API, and until then there will be breaking changes.

Development

You can debug and test the viewer is through the viewer-sandbox package. Some simple steps to get going:

  • run yarn in the repo root to install and link all required dependencies.
  • run yarn dev in the viewer package (here) to start a dev build with automatic code refresing of the viewer code.
  • run yarn dev in the viewer-sandbox package to start the viewer sandbox.

API

The Viewer's API is documented here.

Community

If in trouble, the Speckle Community hangs out on the forum. Do join and introduce yourself! We're happy to help.

License

Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. If you have any questions, don't hesitate to get in touch with us via email.