=================
This package is designed to give a solution for those who wish to use livecycle collaborative features with their own preview environments.
Livecycle package is bundled with an sdk and a cli.
The sdk is used to create an agent within your html document to allow livecycle collaboration magic to happen. While the CLI is used to link between your preview environment url to livecycle playground.
Setting up is as simple as it gets.
Livecycle SDK
Integrate livecycle with your existing preview environment and enjoy contextual collaboration tools.
Prerequisite
The livecycle SDK is intended to be used with projects that already have a working preview environment setup and wish to use livecycle collaboration solution.
If you or your team don't have a preview environment as part of your flow, you could use our end to end solution.
Installation - with a package manager
npm i livecycle
or
yarn add livecycle
Initialize livecycle at the root of your project
import Livecycle from 'livecycle-sdk'
await Livecycle.init().catch(console.error)
Browser Support
Livecycle can be used in any browser that supports es2018 features and above.
How does it work?
We use the sdk to embed a script tag in your DOM that runs an agent in the background.
The agent job is to provide a communication channel between your environment and the livecycle application.