Event Store component library and frontend utilities
Ensure you have NodeJS >=16.10 (current LTS) installed.
This repository uses Yarn with offline cache.
corepack enableyarnWe use changesets to help us prepare releases. It helps us update package versions and add notes to the CHANGELOG.md for any package that's changed.
A changeset is a record of changes made to specific packages. Create one when you need to publish a change that affects a package or the release notes. Not all changes need a changeset, though. For example, if your changes don't affect a package or the release notes, you don't need a changeset.
- Run
yarn changelog - Follow the prompts to describe your changes and pick the packages they affect. This selection helps determine which package versions need updates.
- This process generates a markdown changeset file in the
.changesetdirectory. Each file outlines your changes and the affected packages. - Include the changeset file(s) in your commit. They're essential for the upcoming release process.
- If necessary, you can generate multiple changesets by running the command multiple times. Each run generates a new changeset file.
- When pull request are merged into
mainbranch, the changesets tool will automatically batch these changesets together and open a pull request with updates to the changelogs and version bumps for the affected packages.
Build packages in the repo:
yarn build| Description | Command | Example |
|---|---|---|
| Build all | yarn build |
|
| Develop package | yarn dev {project} |
yarn dev layout |
| Build Docs | yarn docs |
|
| Serve built Docs | yarn docs:serve |
|
| Develop Docs | yarn dev docs |
|
| Lint all | yarn lint |
|
| Test all | yarn test |
|
| Run a command in a workspace | yarn nx run {project}:{command} |
yarn nx run layout:icon |