@rxap/plugin-web3-storage
Version:
This plugin provides an executor to deploy your application to web3 storage. It also includes a generator to initialize the plugin. It simplifies the process of deploying web applications to decentralized storage.
48 lines (37 loc) • 1.84 kB
Markdown
This plugin provides an executor to deploy your application to web3 storage. It also includes a generator to initialize the plugin. It simplifies the process of deploying web applications to decentralized storage.
[](https://www.npmjs.com/package/@rxap/plugin-web3-storage)
[](https://commitizen.github.io/cz-cli/)
[](https://github.com/prettier/prettier)



- [Installation](#installation)
- [Generators](#generators)
- [init](#init)
- [Executors](#executors)
- [deploy](#deploy)
# Installation
**Add the package to your workspace:**
```bash
yarn add @rxap/plugin-web3-storage
```
**Execute the init generator:**
```bash
yarn nx g @rxap/plugin-web3-storage:init
```
# Generators
## init
> Initialize the package in the workspace
```bash
nx g @rxap/plugin-web3-storage:init
```
# Executors
## deploy
> deploy executor
Option | Type | Default | Description
--- | --- | --- | ---
endpoint | string | | The endpoint of the web3 storage service
key | string | | The key used to authenticate with the web3 storage service
proof | string | | The proof used to authenticate with the web3 storage service
rateLimit | number | | The rate limit in seconds of the web3 storage service
buildTarget | string | | The build target from which the output should be deployed