In this guide, we'll be adding all Weavy features as custom components so they'll show up in the Component Library in your Retool app - just drag and drop!
You will need:
First, we need an API key to communicate with the Weavy backend.
Before you can work with Weavy, you'll need to sign up for an account or sign into your existing account.
The repo contains everything you need to set up and configure the demo app and use Weavy as custom components in your Retool app.
git clone https://github.com/weavy-labs/retool-weavy-components.git retool-weavy-componentsretool-weavy-components and run:npm installWe need the environment URL and an API key to communicate with the Weavy backend. To make this available for the scripts in the repo, we need to place it in an .env file.
.env file in the root of the project
WEAVY_URL="WY_BACKEND_URL"
WEAVY_APIKEY="WY_API_*****************"WY_BACKEND_URLwith the URL to your Weavy backend.WY_API_***************** with an API key for your Weavy backend.You can find this information in your Weavy account.
You haven't selected an API key. If you do - code snippets, scripts and files you download will automatically be updated with API key and backend URL.
.env file in the root of your project folder, copy and paste the above into the file.The installation scripts are using the Retool CLI and the Custom Components Library utils to create the demo.
npm run loginOnce you have your Retool authentication configured, you can run the installation script to upload and configure the Weavy components and the demo app.
npm run create:demoThe script will automatically configure the following:
WEAVY_URL Javascript variable. You can see it under Settings > Advanced settings > Preloaded Javascript in your Retool account.WeavyAuthentication workflow for authentication token handling in the Workflows section in Retool. The Workflow is configured with your Weavy API key.WeavyPageNavigation workflow in the Workflows section for saving page metadata that is needed by Weavy Notifications to be able to navigate back to the container their content originated from. The Workflow is configured with your Weavy API key.Weavy components under Settings > Custom Components Library in your Retool account.Weavy Components - Basic Layout in the Apps section in Retool.Click the link in the terminal window, and there we have it - a complete Retool demo app using Weavy components.
Select data in the table and see how the right panel updates with collaboration components. In the top right corner, you can also see a messenger icon; click it to open a drawer with our messenger component.
It even works with notifications - toasts, deep navigation, and all - see the notifications icon in the top bar.
Now, imagine all this in your app!
To access live chat with our developer success team you need a Weavy account.