Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (location-microfrontend) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Location Micro Component

Tech Stack Required

React 18
Node 18.16+
PNPM (to install dependencies)
RSPACK (for build configuration)

Force install packages using pnpm only

We have applied force install using pnpm package only (NPM/YARN or any other package manager won't work) To apply force install we have incleded below script to package.json

  "engines": {
    "npm": "Use PNPM package manager to install Dependencies/devDependencies",
    "pnpm": ">= 8.6.5",
    "node": ">= 18.16.0"
  }

Then created .npmrc file and included below command

engine-strict = true

Create `credentials` file inside `<project-root>/package/view` directory

Folder will contain index.ts file which will include your token and user details in below format.

export const config = {
  isRTMRequired: true,
  params: {
    merchantId: <MERCHANT_ID>,
    brandId: <BRAND_ID>,
  },
  environment: <ENVIRONMENT [STAGHE/LIVE/PRE-ALPHA]>,
  token: <ACCESS-TOKEN-WITHOUT-BEARER>
};

Environment Variable

We need to create .env file in root direectory <project-root>/, include below environment variable to run the project.

NODE_ENV=development
RSPACK_CONFIG_VALIDATE=loose rspack build
REACT_APP_MODE=development
GITHUB_REF_NAME=main
SENTRY_AUTH_TOKEN=<SENTRY_AUTH_TOKEN>
SONAR_AUTH_TOKEN=<SONAR_AUTH_TOKEN>
RTM_API_KEY_DEV=<RTM_DEV_KEY>
RTM_API_KEY_PROD=<RTM_PROD_KEY>
GOOGLE_MAP_KEY=<GOOGLE_API_KEY>

Enable loose validation mode will print out erroneous configurations but will not throw error.

RSPACK_CONFIG_VALIDATE=loose rspack build

Enable loose validation mode, without printing errors or throwing error.

RSPACK_CONFIG_VALIDATE=loose-silent rspack build

To run sonarqube validation checks include below environment variable, you will get the token from

https://sonar.anywhere.co/ SONAR=

To capture sentry log include below environment variable

https://sonar.anywhere.co/ SENTRY_AUTH_TOKEN=

Debug development environment

DEBUG=builder pnpm dev

Start Project Command

npm run start:view

location-microfrontend