speckle-server/packages/frontend

The Speckle Frontend App

Disclaimer

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

Notes:

• In development mode, the Speckle Server will proxy the frontend from localhost:8080 to localhost:3000. If you don't see anything, ensure you've run npm run dev in the frontend package.

• In production mode, the Speckle Server will statically serve the frontend app from /dist. You will need to run npm run build to populate this folder.

Documentation

Comprehensive developer and user documentation can be found in our:

📚 Speckle Docs website

Project setup

The frontend now includes the viewer. Until we get to publish it as a separate module, there's a few extra steps:

• make sure you build the Speckle Viewer
• afterwards, run lerna bootstrap

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

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. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via email.