This is the Speckle Server, which coordinates communications between the various SpeckleClients. It provides a basic accounts system, stream coordination, design data collation and retrieval, live update events and a basic querying mechanism.
Perquisites:
- A machine running docker.
- Have
gitinstalled too.
Please note: the speckle server application is a clustered service that will spawn as many instances as you have CPU cores.
Steps:
-
Clone this repository and change your working path to this repository:
git clone https://github.com/speckleworks/SpeckleServer.gitthencd SpeckleServer. -
Run
docker-compose up -d. This will take a bit of time at first. To stop the service, rundocker-compose down. -
Visit your speckle server http://localhost or whatever the IP address of your VPS is.
More detailed instructions coming soon. Simply spin off an instance of Redis & Mongo locally, make sure in config.js that you're connecting to them, and spin out the server with nodemon server.js if you want live reloads or node server.js otherwise.
API docs are here - they are a good overview of what you can do with the speckle server.
Developed by Dimitrie A. Stefanescu @idid / UCL The Bartlett / InnoChain / Jenca
This project has received funding from the European Union’s Horizon 2020 research and innovation programme under the Marie Sklodowska-Curie grant agreement No 642877.
MIT.