https://github.com/specklesystems/speckle-excel
Speckle connector for Excel
https://github.com/specklesystems/speckle-excel
aec architecture bim excel speckle
Last synced: 3 months ago
JSON representation
Speckle connector for Excel
- Host: GitHub
- URL: https://github.com/specklesystems/speckle-excel
- Owner: specklesystems
- License: apache-2.0
- Created: 2021-05-07T20:05:59.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T18:36:56.000Z (7 months ago)
- Last Synced: 2025-03-01T13:45:45.708Z (3 months ago)
- Topics: aec, architecture, bim, excel, speckle
- Language: Vue
- Homepage: https://speckle.systems/tag/excel/
- Size: 608 KB
- Stars: 19
- Watchers: 3
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Speckle | Excel
> Speckle is the first AEC data hub that connects with your favorite AEC tools. Speckle exists to overcome the challenges of working in a fragmented industry where communication, creative workflows, and the exchange of data are often hindered by siloed software and processes. It is here to make the industry better.
Speckle Connector for Excel
## 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](https://speckle.guide/dev/)
## Developing & Debugging
### App Set up
For developing and debugging this connector you'll need to set up a Speckle App.
The server on which the app runs must be on `https`, so **do not use a local Speckle server** on `http://localhost:3000/` as it will not work.
You can use `https://latest.speckle.dev/` or `https://speckle.xyz/`.
Now open up its frontend, and under your profile register a new app.
I've used the following values since my excel-connector app is running at `https://localhost:3000`:
- name: ExcelConnector
- redirect url: `https://localhost:3000`
- permissions: `streams:read, streams:write, profile:read, profile:email, users:read`
Take note of the `app id` and `secret`, then in your speckle-excel repo:
- duplicate `.env sample` to `.env.local`
- then fill it in with your new `app id` and `secret`
- note that the `BASE_URL=https://localhost:3000`
### Running the connector locally
Run it locally:
- `npm install` (first time only)
- `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](.github/CONTRIBUTING.md) for an overview of the best practices we try to follow.
## Community
The Speckle Community hangs out on [the forum](https://discourse.speckle.works), 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](mailto:[email protected]).