1.0.7 • Published 1 month ago

@bloomreach/navigation-application v1.0.7

Weekly downloads
-
License
-
Repository
-
Last release
1 month ago

Bloomreach Navigation Application

Introduction

This project contains the code for the navigation application, nav-app. The nav-app is the container application of micro-frontends in BRX. Through configuration it allows the loading of isolated apps inside iframes hosted on any domain.

These client apps can then use the @bloomreach/navigation-communication library to communicate with the nav-app API to execute tasks.

Structure

This is an Angular workspace generated by the Angular CLI. The src folder contains the nav-app application.

Development

For a development setup:

  1. Run npm ci
  2. Run npm run start

Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Note: the development setup for the nav-app expects the ./apps/example-iframe-application to be running on http://localhost:5000/. Please follow the instructions in the ./apps/example-iframe-application README to start the example app.

Build

To produce a production build:

  1. Run npm ci
  2. Run npm run build

The build artifacts will be stored in the dist/ directory.

Running unit tests

To run the unit tests:

  1. Run npm run test

Linting

To run the linter:

  1. Run npm run lint

This will lint both the TypeScript and the SCSS files.