The Speckle Server, Frontend, 3D Viewer, & other JS utilities.
Перейти к файлу
Dimitrie Stefanescu 628fac0be0
Merge pull request #84 from gjedlicska/viewer_in_docker
WIP: Viewer in docker
2021-01-26 14:02:03 +00:00
.circleci chore(docs/ci): fixed minor formatting in readme, added todos in circle ci yaml 2021-01-04 14:04:21 +02:00
packages feat(viewer): Added polycurve conversion. 2021-01-26 12:46:12 +01:00
test-queries fix(tests & queries): added graphql handlers for object children, tests, and refactoring 2020-05-13 14:19:46 +01:00
.dockerignore fix(git and docker ignore files): merged node_modules ignore commands into a single glob pattern 2021-01-26 09:27:14 +01:00
.editorconfig feat(gql): adds UserSearchResults and improves user search 2020-07-27 23:13:20 +01:00
.gitignore Merge pull request #84 from gjedlicska/viewer_in_docker 2021-01-26 14:02:03 +00:00
CONTRIBUTING.md docs: removes all links to slack 2021-01-06 16:42:56 +00:00
Dockerfile fix(dockerfile): add viewer to the docker build process 2021-01-26 09:29:04 +01:00
ISSUE_TEMPLATE.md Create ISSUE_TEMPLATE.md 2020-08-25 16:03:28 +03:00
LICENSE Create LICENSE 2020-08-26 14:24:39 +03:00
lerna.json refactor(global): restructures repo with lerna 2021-01-03 13:35:53 +02:00
package.json refactor(global): restructures repo with lerna 2021-01-03 13:35:53 +02:00
readme.md Update readme.md 2021-01-25 09:16:49 +00:00

readme.md

Speckle Web

Twitter Follow Discourse users website

Status

Speckle-Next codecov

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.

Developing and Debugging

To get started, first clone this repo. Check out the detailed instructions for each module in their respective folder (see links above).

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 server or frontend as 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.