generator-ls-iwa

generator-ls-iwa

A Yeoman generator for creating Liquid State Integrated Web Apps (IWAs)

This generator creates a mono repo structure for your whole IWA project, as well as providing a subgenerator to create the individual IWAs.

Installation

This project uses a monorepo and yarn workspaces, you will need to have yarn installed before continuing.

First, install Yeoman and generator-ls-iwa using yarn (we assume you have pre-installed node.js).

yarn global add yo generator-ls-iwa

Then generate your new project:

yo ls-iwa

This will create the basic structure, as well as creating packages for common components and theme. You can now add as many IWAs to the project as you need.

To generate a new IWA you once again use the generator but this time accessing the iwa subgenerator.

yo ls-iwa:iwa

This will ask you a couple of quick questions before generating your new IWA, linking it to the theme and common packages, and adding it to the project storybook.

Contributions

Updating dependencies

Since this is a base template for projects, it is a good idea to keep it and its dependencies regularly updated.

This is the process to update dependencies:

• ensure all dependencies and dev dependencies listed in package.json are pinned to their major versions (i.e. start with a caret "^")
• run yarn outdated
• review the dependencies and the impact that an update to the latest version minor version indicated in the "Wanted" column would have on the code.
• run yarn upgrade

License

MIT © Liquid State