speckle-excel/README.md

Speckle Excel Connector

Introduction

This repo holds Speckle's Excel Connector, it's currently released as early alpha.

Documentation

Comprehensive developer and user documentation can be found in our:

📚 Speckle Docs website

Developing & Debugging

Register the app:

• create a Speckle App on your server
• duplicate .env sample to .env.local
• then fill it in with your variables

Run it locally:

• npm install
• npm run serve
• You might be prompted to install some certificates, go ahead and accept
• Wait for the the process to start the Vue app, then in a separate terminal either
  • npm run excel will run excel desktop and sideload the plugin
  • npm run excel:web will run excel web, open the document defined in packages.json and sideload the plugin

If this worked out well, you should see the connector sideloaded correctly:

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!

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.