Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.34 KB

local-development-guide.md

File metadata and controls

34 lines (21 loc) · 1.34 KB
Raw

Local development guide

This project was generated using Nx.

If you wish to contribute to this repository, below are the steps for local development.

  • Clone the repository git clone https://github.com/udayvunnam/xng-breadcrumb.git
  • Run pnpm to install the dependencies
  • Run pnpm start to build and watch both the library and the demo app. This opens the demo app at http://localhost:4200/ automatically.

Build

Run pnpm build to build the library and demo app together. The build artifacts will be stored in the dist/ directory.

This step is used by CI to build both the library and the demo app. After a successful build, the demo apps are deployed to Vercel.

Publish to npm

Run pnpm release on main branch if you wish to publish a new version of library to npm

This ingternally uses standard-version to

  • bump the library version based on the commits
  • generates changelog
  • commit bump files and changelog
  • create a new tag with the new version number

GitHub Actions CI gets notified on every new tag push and publishes the library if build and tests are success

Tests

  • Unit tests: pnpm test to execute the unit tests via Jest
  • e2e: pnpm e2e to execute the e2e tests via Cypress.io