Skip to content

iltabe/speckle-sharp

 
 

Repository files navigation

Speckle Sharp: The Speckle 2.0 .NET SDK, Connectors, and Interoperability Kit

Twitter Follow Community forum users website docs

What is Speckle?

Speckle is the Open Source Data Platform for AEC. Speckle allows you to say goodbye to files: we give you object-level control of what you share, infinite versioning history & changelogs. Read more on our website.

Status

.NET Core

Introduction

This monorepo is the home to our Speckle 2.0 C# projects. The Speckle Server is providing all the web-facing functionality and can be found here.

Specifically, this repo holds:

➡️ Core, the .NET SDK.

Speckle Core is the canconical SDK for Speckle. It supports multiple data transports, and advanced decomposition API for design data, and offers a dynamic base for object definition.

➡️ Objects

The Objects Kit is our default interoperability kit. Read more about kits and their role in the Speckle ecosystem here.

➡️ Speckle Connectors:

The Speckle Connectors are plugins that embed with an application and provide the interface between its API and Speckle. Currently we have:

➡️ DesktopUI

The DesktopUI project contains the reusable ui for all non-visual programming connectors. If you're embarking on developing a new connector, we recommend starting from here.

Documentation

Comprehensive developer and user documentation can be found in our:

Developing & Debugging: First Step

Clone this monorepo and check the readme of you project you're interested in! We encourage everyone interested to debug / hack /contribute / give feedback to this project.

A note on Accounts: The connectors themselves doesn't have features to manage your Speckle accounts, this functionality has been delegated to the Speckle Manager desktop app. You can install an alpha version of it from here. After installing it, you can use it to add/create an account on the Server.

Contributing

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

Community, Questions and Feeback:

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.

About

The Speckle 2.0 .NET SDK, Connectors, and Interoperability Kit

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 100.0%