This is the Desktop UI for Speckle 2.0 Desktop Connectors 🎉

This project on its own is just a WPF application that doesn't do a whole lot. The magic comes when you implement the ConnectorBindings to make it a functional connector for whatever software application you require! It is currently up and running in the Revit Connector - take a look!

This UI is currently in ⚠ALPHA⚠ and is a bit rough around the edges -- please use at your own risk! Play with it, break some stuff, and come back to us with feedback comments, suggestions, etc ✨

Comprehensive developer and user documentation can be found in our:

The UI will run on it's own, but it won't do much beyond creating and adding empty streams. You can have a look around though to get a feel for it. It uses DummyBindings which you can edit to try implementing some of the intended functionality.

• A Speckle Server running (more on this below)
• Speckle Manager (more on this below)

To get the UI running, all you need to do is hit debug in your IDE. There are however a few things you'll need to set up beforehand.

In order to test Speckle in all its glory, you'll need a server running. You can run a local one by simply following the instructions in the Server Repo

If you're facing any errors, make sure Postgres and Redis are up and running.

The connector itself 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.

You'll need to implement the ConnectorBindings for your application to allow the UI to interact with it. The Revit Connector is a good place to look for reference.

To start the UI from within your appliation, you'll need to create an instance of the UI Bootstrapper and give it an instance of your bindings. You then just need to call Setup on the Bootstrapper and you're on your way 🚀

// create a new bindings instance
var bindings = new MyConnectorBindings();

// give it to the bootstrapper
var bootstrapper = new Bootstrapper()
{
  Bindings = bindings
};

// fire it up, baby!
bootstrapper.Setup(Application.Current);

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

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

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.