Speckle Examples

Introduction

This repo contains example projects and scripts to get started using Speckle on any of our supported languages.

The repo is divided into folders by language, so that it's easier to navigate and find any example.

You'll find folders for the following languages:

• dotnet/: Examples relating to Microsoft's .Net programming language
  • dotnet-speckle-starter: A basic starter project using Speckle NuGet libraries to receive and send data, as well as handling local accounts in your machine and creating new commits.
  • dui-speckle-starter: A basic starter project showcasing the use of our Desktop UI library, simplifying the connection between desktop applications and Speckle, and reducing the amount of code required for a new Desktop connector.
• python/: Examples relating to the python programming language
  • speckle-py-starter: A basic starter project our specklepy library to receive and send data, as well as handling local accounts in your machine and creating new commits.
  • speckle-jupyter-notebooks: Basic primer examples for using the specklepy library within Jupyter notebooks for accessing, processing and writing Speckle data.
• javascript/: Examles relating to the javascript programming language
  • speckle-js-starter: Basic example website showcasing communication with the Speckle GraphQL API and basic functionality of the 3D Viewer npm package (viewing speckle data, setting events such as selection or double-click...)

Documentation

Comprehensive developer and user documentation can be found in our:

📚 Speckle Docs website

Developing & Debugging

Each project should contain it's own readme.md file, detailing any steps required to run the examples.

Contributing

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

Community

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

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.