@openforge/suw-storybook-portals
v0.2.99
Published
This project was generated using [Nx](https://nx.dev).
Downloads
64
Keywords
Readme
SUW UI Libraries
This project was generated using Nx.
🔎 Smart, Fast and Extensible Build System
Public Access URL (DEMO)
Quick Start & Documentation
10-minute video showing all Nx features
Public Access URL (DEMO)
Create new Library
npx nx generate @nrwl/angular:library myLib --buildable --publishable --import-path=@myLib/importPath --prefix=my-lib-prefix --tags=myLib
This command will generate a new Library and prepare it to be buildable and publishable automatically.
Add Component to a Library
npx nx generate @nrwl/angular:component myComponent --selector=my-selector --project=myLib --export
This command will generate the files needed for the new component into the specified Library. Also it will add the needed export to the Library index file.
Add Storybook to a Library
npx nx generate @nrwl/angular:storybook-configuration myLib
This command will add the needed configuration to run and build storybook on the Library project.json
Generate Stories for a Library
npx nx generate @nrwl/angular:stories myLib
This command will add the stories files into the Library components
Running Storybook
npx nx storybook myLib
This command will serve the stories from the Library. Navigate to localhost:4400 to see all the stories.
Deployment of Storybook
Current Storybook suw-storybook-ui
uses github actions to deploy automatically latest develop changes to demo site
After any changes under libs folder gets pushed github workflow will be triggered and site will be updated
Running unit tests
Run ng test my-app
to execute the unit tests via Jest.
Run nx affected:test
to execute the unit tests affected by a change.
Understand your workspace
Run nx graph
to see a diagram of the dependencies of your projects.
Further help
Visit the Nx Documentation to learn more.
☁ Nx Cloud
Distributed Computation Caching & Distributed Task Execution
Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.
Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.
Visit Nx Cloud to learn more.