Speckle | Server

Speckle is the first AEC data hub that connects with your favorite AEC tools. Speckle exists to overcome the challenges of working in a fragmented industry where communication, creative workflows, and the exchange of data are often hindered by siloed software and processes. It is here to make the industry better.

Server and Web packages

Repo structure

This monorepo is the home of the Speckle v2 web packages:

• packages/server: the Server, a nodejs app. Core external dependencies are a Redis and Postgresql db.
• packages/frontend: the Frontend, a static Vue app.
• packages/viewer: a threejs extension that allows you to display 3D data
• packages/objectloader: a small js utility class that helps you stream an object and all its sub-components from the Speckle Server API.
• packages/preview-service: generates object previews for Speckle Objects headlessly. This package is meant to be called on by the server.
• packages/webhook-service: making external webhook calls
• packages/fileimport-service: parsing and importing files

Other repos

Make sure to also check and ⭐️ these other Speckle repositories:

• speckle-sharp-connectors: .NET connectors and desktop UI
• speckle-sharp-sdk: .NET SDK, tests, and Objects
• specklepy: Python SDK 🐍
• speckle-sketchup: Sketchup connector
• speckle-excel: Excel connector
• speckle-unity: Unity 3D connector
• speckle-blender: Blender connector
• speckle-unreal: Unreal Engine connector
• speckle-qgis: QGIS connector
• speckle-powerbi: PowerBi connector
• and more connectors & tooling!

Developing and Debugging

Have you checked our dev docs?

We have a detailed section on deploying a Speckle server. To get started developing locally, you can see the Local development environment page.

TL;DR

We're using yarn and its workspaces functionalities to manage the monorepo. Make sure you are using Node version 18. To get started, run:

1. corepack enable
2. yarn
3. yarn build

After this, you can use the scripts in the individual packages or run them all in dev mode:

• yarn dev

For development you'll also want to run yarn dev:docker:up which will start up the docker containers you will need to be able to run the apps on your machine.

IDE

The suggested IDE for working in this repo is VSCode, because the repo has special configs to improve the DX there (auto-format & auto-lint, recommended extensions etc.).

This repository relies on VSCode multi-root workspaces, so for the best DX and proper formatting/linting make sure you open the project using the workspace.code-workspace file instead of just opening the folder in VSCode.

Proper TypeScript support

To get proper TS support in standard TS files as well as Vue files, we rely on the Volar VSCode extension - not Vetur! When you open the workspace for the very first time, VSCode should already prompt you to install this extension. The default Volar setup can be quite resource intensive, however, because there end up being standard TS Language Server instances running as well as Vue TS Language server instances. To resolve this issue we rely on Volar's Take Over Mode.

Essentially, ensure you have Volar enabled, and the built in TypeScript and JavaScript Language Features extension disabled (for this workspace)!

Useful containers

Maildev

We have a Maildev container available that you can use to see all e-mails sent out from the app. Make sure your server .env file is configured properly to use it:

EMAIL=true
EMAIL_FROM="no-reply@example.org"
EMAIL_HOST="localhost"
EMAIL_PORT="1025"

The web portal is available at localhost:1080 and it's listening for mail on port 1025.

Contributing

Please make sure you read the contribution guidelines for an overview of the best practices we try to follow.

When pushing commits to this repo, please follow the following guidelines:

• When ready to commit, run $ yarn cz & follow the prompts.

When committing to git, an automated script will run. This will check that your commit conforms to Speckle's guidelines.

• To enable additional checks, you may wish to optionally install the following:

  • pre-commit
  • hadolint
  • shellcheck
  • helm
  • circleci
  • ggshield

• Please note that these additional checks will be run by Speckle's automated CI environment and non-conformances, if any, may prevent your Pull Request from being merged.

• Please use the name of the package as the scope of your commit.

• Note that ggshield requires you to register an account and then authorise with GitGuardian before it can be used: ggshield auth login

• Then run to enable pre-commit. This will run on every commit you make:

  pre-commit install
  

Security

For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems.

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.