You can get started in 3 steps:
- Run
pnpm installto install project dependencies. - Run
pnpm buildto buildblueprints-v2-addonand v2 addons in thepackagesfolder. - Run
pnpm startto startdocs-app(http://localhost:4200) andtest-app(http://localhost:4300/tests).
Important
After pnpm build in step 2, you need to run pnpm install again to install blueprints-v2-addon. This extra install needs to be done just once, and may be streamlined later.
Create addon
From the workspace root, run the new command to create an addon in packages. The addon will be included in docs-app and test-app.
pnpm addon new <name> [options]
# Example: Create the addon `ui-form`
pnpm addon new ui-form
# Example: Specify the location for a scoped package
pnpm addon new @my-org-ui/form --location ui/formDon't forget to run pnpm install to install the addon's dependencies.
Lint and test
From the workspace root, you can run these commands to apply the action to all packages.
# Check errors
pnpm lint
# Fix errors
pnpm lint:fix
# Run tests
pnpm testTo save time, you can instead run the commands above in some package's root. This will affect only that package.
# Example: Check errors in `@my-org-ui/form`
cd packages/ui/form
pnpm lintLive reload
Change the current directory to the addon that you want to work on. Run the start command to rebuild the addon automatically.
# Example: Run `@my-org-ui/form`
cd packages/ui/form
pnpm startAssuming that docs-app and test-app are running, these apps will rebuild after you save a change to the addon.
If you don't see a live reload occur, try restarting the apps.