The Nx Plugin for Web Components contains generators for managing Web Component applications and libraries within an Nx workspace. It provides:
- Integration with libraries such as Jest, Cypress, and Storybook.
- Scaffolding for creating buildable libraries that can be published to npm.
- Utilities for automatic workspace refactoring.
Setting Up Web
To create a new workspace with web, run
npx create-nx-workspace@latest --preset=web-components.
Make sure to install the
@nx/web version that matches the version of
nx in your repository. If the version numbers get out of sync, you can encounter some difficult to debug errors. You can fix Nx version mismatches with this recipe.
To add the web plugin to an existing workspace, run one of the following:
# For npm users
npm install -D @nx/web
# For yarn users
yarn add -D @nx/web
You can add a new application with the following:
The application uses no framework and generates with web components. You can add any framework you want on top of the default setup.
To start the application in development mode, run
nx serve my-new-app.
If you are looking to add a React application, check out the React plugin.
To create a generic TypeScript library (i.e. non-framework specific), use the
nx g @nx/js:lib my-new-lib
# If you want the library to be publishable to npm
nx g @nx/js:lib my-new-lib \
You can run unit tests with:
nx test my-new-app
nx test my-new-lib
my-new-app with the name or your project. This command works for both applications and libraries.
You can also run E2E tests for applications:
nx e2e my-new-app-e2e
my-new-app-e2e with the name or your project with
React applications can be build with:
nx build my-new-app
And if you generated a library with
--buildable, then you can build a library as well:
nx build my-new-lib
The output is in the
dist folder. You can customize the output folder by setting
outputPath in the project's
The application in
dist is deployable, and you can try it out locally with:
npx http-server dist/apps/my-new-app
The library in
dist is publishable to npm or a private registry.