speckle/speckleserver repository overview

⁠Speckle Server

This is the Speckle Server, which coordinates communications between the various bits of the Speckle ecosystem.

⁠API

API docs are here⁠ - they are a good overview of what you can do.

⁠Installation

The Speckle Server is a nodejs (v.8+, latest stable preffered) app.

• Dependencies: mongodb⁠ and redis⁠.
• Clone this repo git clone https://github.com/speckleworks/SpeckleServer.git
• Configuration: create a .env using .env-base as a template, and fill in the required information.
• Run npm install and thereafter npm run.

⁠⚠️ Warning: if these instructions seem confusing and you want to use speckle in production, please consult someone with more experience! Incorrect configuration can have security and reliability implications.

⁠🍰 If you just want to try out speckle, at your own risk, you can use https://hestia.speckle.works/api.

Note: hestia is hosted on Digital Ocean. If you want to signup to digital ocean and support the running costs of speckle, use the following affiliate link⁠ to get $100 in credit.

To install a front-end plugin, such as the admin ui⁠, clone the respective repo in the plugins folder of the server.

⁠Get In Touch

If you have any questions, you can get in touch with the rest of the world-wide specklers via:

• Discourse⁠
• Slack⁠

⁠License

MIT⁠