open-index/open-npm huggingface dataset:
npm package: @lightningrodlabs/create-we-applet
Description: Easily scaffold a [We Applet](https://npmjs.com/package/@lightningrodlabs/we-applet) UI package.
Latest version: 0.0.12

# @lightningrodlabs/create-we-applet

Easily scaffold a [We Applet](https://npmjs.com/package/@lightningrodlabs/we-applet) UI package.

## Usage

Run this in the project subfolder where you want to create the applet:

```bash
npx @lightningrodlabs/create-we-applet [APPLET NAME]
```

For example:

```bash
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:

1. In your root `package.json`:
   1. Include the newly scaffolded package in the `workspaces` field.
2. In the `we-applet` package, add the dependency to your local package where your elements and store live, and run `npm install` from the root folder of the repository.
3. In the `we-applet/src/[APPLET NAME]-applet.ts` file:

   1. Instantiate your store in the `firstUpdated` function.
   2. Add your elements to the `static get scopedElements()` getter.
   3. Add your elements to the HTML for them to render appropriately.
4. In the `workdir/dna.yaml` file for the generated applet, change the location of the zome.
5. In the `package.json` file for the generated applect, change the `CARGO_TARGET_DIR` directory to which you will be compiling.
6. Change the `icon.png` to the icon you would like this applet to have.