Cristian Balas
66997375f5
* Run basic tests on the deployment after every CI deployment * Run basic tests on the deployment after every CI deployment
Speckle Web
Status
Disclaimer
We're working to stabilize the 2.0 API, and until then there will be breaking changes.
Introduction
This monorepo is the home of the Speckle 2.0 web packages. If you're looking for the desktop connectors, you'll find them here.
Specifically, this monorepo contains:
➡️ Server, the Speckle Server.
The server is a nodejs app. Core external dependencies are a Redis and Postgresql db.
➡️ Frontend, the Speckle Frontend.
The frontend is a static Vue app.
➡️ Viewer, the Speckle Viewer.
The viewer is a threejs extension that allows you to display data from Speckle.
Documentation
Comprehensive developer and user documentation can be found in our:
📚 Speckle Docs website
Usage
We offer a free server that you can use straight away (create accounts, etc.).
We can also help you manage your Server deployments (setting things up securely, automatic upgrades, support, etc)
See https://speckle.systems/getstarted/ for more details on our offerings.
If you want to deploy the Server, we have a detailed guide on how to do so:
➡️ Server deployment instructions
Developing and Debugging
To get started, you can read the Run in development mode chapter of our deployment guide
Contributing
Please make sure you read the contribution guidelines for an overview of the best practices we try to follow.
When pushing commits to this repo, please follow the following guidelines:
- Install commitizen globally (
npm i -g commitizen). - When ready to commit,
git cz& follow the prompts. - Please use either
serverorfrontendas the scope of your commit.
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.