# The Speckle Viewer API 2.0

[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fspeckle.community&style=flat-square&logo=discourse&logoColor=white)](https://speckle.community) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) [![npm version](https://badge.fury.io/js/%40speckle%2Fviewer.svg)](https://badge.fury.io/js/%40speckle%2Fviewer)

## Documentation

This is an early build for the viewer's API 2.0, released with the intention of gathering feedback. No features or functionalities should be considered final

## Documentation

Quick Reference guide [here](https://www.notion.so/speckle/Viewer-API-2-0-Quick-Reference-0638b4f31b7c4e04a7ef0c1a0ac20854)

## Examples

You can find readily available examples here:

- [Basic Setup](https://codesandbox.io/s/basic-setup-jf4ccn)
- [Measurements Extension](https://codesandbox.io/s/measurement-tool-frmffj)
- [Obj Loader](https://codesandbox.io/s/obj-loader-pydvhz)
- [Expanding an Extension (Manipulating Objects)](https://codesandbox.io/s/manipulating-objects-yydx4q)
- [Custom Extension (Categorize)](https://codesandbox.io/s/categorize-7jw7lw)

## Examples

You can find readily available examples here:

You can debug and test the viewer API 2.0 through the `viewer-sandbox` package on `alex/API2.0` branch from the `speckle-server` repository. 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.

## Feedback

We would love to hear your feedback in [this forum thread](https://speckle.community/t/seeking-feedback-on-the-new-viewer-api-structure/7231).

## Community

If in trouble, the Speckle Community hangs out on [the forum](https://speckle.community). 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](mailto:hello@speckle.systems).
