Beta.Speckle is an online parametric model viewer. It enables sharing with your clients/stakeholders/community flexible designs, not just static artefacts.
CSS JavaScript HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
.sass-cache
app
assets
config
spkw
views
.gitignore
contributing.md
favicon.ico
future.speckle.sublime-project
future.speckle.sublime-workspace
license.txt
package.json
readme.md
server.js

readme.md

Beta.Speckle

About

Beta.Speckle is an online parametric model viewer. It enables sharing with your clients/stakeholders/community flexible designs, not just static artefacts.

Check the service in action on http://beta.speckle.xyz. For now, it is developed by @idid.

Why?

Design iteration has always been difficult to communicate with the right people, that's why we devised a tool to help leverage the flexibility of computational design in environments outside the architectural office.

Parametric models can go beyond aesthetic and technical exploration: they can tell a story and they can be the base of collaborative decision making.

The Approach

SPK has very little moving parts, and is geared towards (eventual) deployment for a wide range of non-technical users and environments.

The current front-end tech stack ensures that on any (evergreen) browser, your model is accessible - mobile devices are supported as well. This is possible one of the few requirements - accessibility and software independence.

All your models are pre-generated on your computer, so essentially the viewer is just loading and displaying static files. This means that there's no computational overhead and we are able to leverage native browser caching and compression - which is fast.

The Parts

There are three main parts:

1. The Backend

Contains:

  • the API
  • the landing page
  • user registration
  • user profile page

2. The Viewer

This is a static front-end that loads & displays the parametric models. It resides within the /spkw directory and is a littl independent module of its own. Check its readme for more information.

3. The Grasshopper Exporter

Has its own github repo. It currently only exists for Rhino/GH. There are other parametric software out there that hopefully you'll help us export from!

Getting started with hacking on your local machine

Important notice: build and watch systems will soon (hopefully) be unified in something more straightforward. Until then, voila the temporary instructions:

  1. npm install
  2. npm run watch
  3. Point your browser to http://localhost:9009 and you should be good to go.

If developing on windows be sure to check issue #25. There are some platform specific troubles that are not yet fixed.

Deploying on your own server

If you want to deploy this to your own server (for various reasons), go ahead! You will need:

  • a mongodb instance running somewhere
  • an Auth0 account if you plan to support authentication

Please give us a heads up if you do this 🙇.

Need Help?

Hit me up @idid or open an issue (preferred).

Contribution Guidelines

See the contribution guidelines.

The Project, Why FOSS, and Why Contribute

The infrastructure for this project is financed for the following three years. See the Credits. Part of our philosophy is to develop this together closely with the stakeholders and end-users, as such any contributions are welcome: feel free to propose new code architecture, features, etc.

Credits

Started off & currently maintained by @idid. Add yourself here if you contribute!

The project is underway at The Bartlett, UCL, within the Innochain Research Project.

This project has received funding from the European Union's Horizon 2020 research and innovation programme under the Marie Sklodowska-Curie grant agreement No 642877.

License

The MIT License (MIT)

Copyright (c) 2016 Dimitrie Andrei Stefanescu & University College London (UCL)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.