Speckle Web

Status

Disclaimer

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

Introduction

This monorepo is the home of the Speckle 2.0 web packages. If you're looking for the desktop connectors, you'll find them here.

Specifically, this monorepo contains:

➡️ Server, the Speckle Server.

The server is a nodejs app. Core external dependencies are a Redis and Postgresql db.

➡️ Frontend, the Speckle Frontend.

The frontend is a static Vue app.

➡️ Viewer, the Speckle Viewer.

The viewer is a threejs extension that allows you to display data from Speckle.

Documentation

Comprehensive developer and user documentation can be found in our:

📚 Speckle Docs website

Developing and Debugging

To get started, first clone this repo. Check out the detailed instructions for each module in their respective folder (see links above).

Bootsrap local Speckle Server

prerequisites: Docker and docker-compose

To get a local Server stack up and running quickly:

• Clone this repository and cd into the repository root:

  git clone https://github.com/specklesystems/speckle-server.git
  cd speckle-server
  

• Start dependencies (postgres and redis) by running:

  docker-compose -f docker-compose-deps.yml up -d
  

• You have 2 options for running the speckle server (frontend + backend):
  • (useful for development) With local development tools (check the Readme.md file in the frontend and server packages)
  • (useful for getting the server running without having local development tools) by starting them inside docker containers:

    docker-compose -f docker-compose-speckle.yml up -d
    

This gets you an empty server running on localhost:3000

Note: the docker containers will automatically restart at startup. To shut them down, you can use docker-compose -f [yml_file_name] down command

For more details and options, check out our Server Setup Docs

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:

• Install commitizen globally (npm i -g commitizen).
• When ready to commit, git cz & follow the prompts.
• Please use either server or frontend as the scope of your commit.

Community

The Speckle Community hangs out on the forum, do join and introduce yourself & feel free to ask us questions!

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.