@lightningrodlabs/create-we-applet
v0.0.12
Published
Easily scaffold a [We Applet](https://npmjs.com/package/@lightningrodlabs/we-applet) UI package.
Downloads
29
Keywords
Readme
@lightningrodlabs/create-we-applet
Easily scaffold a We Applet UI package.
Usage
Run this in the project subfolder where you want to create the applet:
npx @lightningrodlabs/create-we-applet [APPLET NAME]
For example:
npx @lightningrodlabs/create-we-applet notebooks
This will create a we-applet
folder, with the necessary setup to create a We Applet. This would usually be a small NPM workspace inside a bigger repository.
If your project was scaffolded using npm init @holochain
, here are your next steps:
In your root
package.json
:- Include the newly scaffolded package in the
workspaces
field.
- Include the newly scaffolded package in the
In the
we-applet
package, add the dependency to your local package where your elements and store live, and runnpm install
from the root folder of the repository.In the
we-applet/src/[APPLET NAME]-applet.ts
file:- Instantiate your store in the
firstUpdated
function. - Add your elements to the
static get scopedElements()
getter. - Add your elements to the HTML for them to render appropriately.
- Instantiate your store in the
In the
workdir/dna.yaml
file for the generated applet, change the location of the zome.In the
package.json
file for the generated applect, change theCARGO_TARGET_DIR
directory to which you will be compiling.Change the
icon.png
to the icon you would like this applet to have.