saasy-ui
v0.0.42
Published
## Run Locally
Downloads
3
Readme
SaaSy UI Component
Run Locally
Clone the project
git clone https://link-to-projectInstall dependencies
npm installCreate a .env file in the root directory
touch .envEnvironment Variables
To run this project, you will need to add the following environment variables to your .env file.
SAASY_SDK_API_KEY -> API key to interact with the saasy sdk.
WALLCONNECT_PROJECT_ID -> WalletConnect Cloud Project ID (free)
Run locally
npm run storybookProp Reference
| Name | Type | Description |
| :------------------- | :-------------------------- | :------------------------------------------------------------------------------------------- |
| icon | string | Required. Image path to icon that is displayed in the top-left |
| termContracts | string[] OR 0x${string}[] | Required. Array of deployed contract addresses with associated terms. |
| companyName | string | Required. Name of company/collection. |
| nftContractAddress | string | Required. Contract address of nft collection. Used to display tokens for user selection. |
| chainIdOfNFT | number | Required. Decimal number of chain ID where the nftContractAddress is deployed to. |
| hasVariableInput | boolean | Required. Displays user input for selecting use-case. Example: Yuga Labs agreement. |
| promisorAddress | string | Required. Wallet address of the one that will countersign the agreement. |
| expirationDate | string | Required. Expiration date of the agreement. Format: MM/DD/YYYY |
| agreementId | string | Required. Unique ID for the collection. Used in the sdk/database for sorting/finding. |
Deployment
Change the version number in package.json.
Build the package
npm run build-libLogin into npm and follow the prompts
npm loginPublish the package
npm publish