@workcanvas/reflect

Workcanvas fork of Reflect

This repo is a fork of the now deprecated Reflect project. It leverages the abilities of reflect and Cloudflare's durable object to create a powerful sync engine. The package is maintained as as seperate npm module inside our main repo.

To publish a version of this package you need:

• Create a NPM account via the website [https://www.npmjs.com/]
• Join workcanvas organization by invite
• Add your credentials locally by running npm adduser which will prompt you to login
• Configure locally workcanvas organization by running npm config set scope workcanvas --global
• Add an organization Github SSH Key to your console:
  • Add SSH Key [https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account]
  • Authorize organization sso [https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on]
• Run node packages/reflect/tool/create-canary.js from the root folder, which will build test and publish a new package version.

When working locally it's best to create a symbolic link between our main repo to the package folder.

• Clone this repo to your local computer
• Run npm link in the reflect root folder
• Run npm link @workcanvascom/reflect in the main repo folder
• To make changes available in our main repo you'll need to build the reflect package by running npm run build