POS Navigator

This is POS Navigator javascript component that lists and shows on map all qarsons points of sale. Library uses react, redux, typescript, css written in SASS preprocessor.

Developing bundler is webpack.

Build production build made as simple tsc compilation with asset files copies provided

Requirements

• nodejs with npm v10 +

Installation:

Installing dependencies

npm install

Build production library files

npm run build

* Build task build two types of library entrypoints :

• "web" - destined to web include (for example by script tag) with all depedencies built in (like react, redux and other third party libraries)
• "ecma script module" - destined for further bundler processing, it is resolved through simply typescript compiling in package.json statement

  tsc -p tsconfig-prod.json && copyfiles "./lib/**/*.!(tsx|ts|d.ts|html)" "dist/esm" -u 1

##Development

Running dev server in standalone mode

npm run start

Running dev mode through bundler in other project. Project should be linked by npm.

npm run build:dev

* build dev emmits files into dist/esm/pos-navigator without CSS / files extraction, it is determined by webpack condition on compilation mode

Running tests

npm run test

####Codestyle

We are in consonance with standardjs.

Validation codestyle:

npm run codestyle-check-typescript

Automatic fix:

npm run codestyle-typescript-fix

####CI (bitbucket pipelines)

Checks codestyles and run tests

##Compilation summary | | npm start - (standalone dev) | npm run build:dev (imported as esm in higher bundler) | npm run build (production build) |---|---|---|---| |key dist files|none|dist/esm/pos-navigator.js|dist/esm/pos-navigator.js, dist/pos-navigator.js, dist/pos-navigator.css |css extraction|no|css in js|esm: css in js, web: extracted |files extraction|no|yes|no (copied)

##App configuration

Pos navigator react app requires simple configuration object in window 'posNavigatorConfig' property.

Example :

var posNavigatorConfig = {
  mobileDevicesBreakpoint: 767,
  googleMapsApiKey: 'passedGoogleMapsApiKey',
    loadingTimeout: 5000,
    cmsConfig: {
      accessToken: 'passedAccessToken',
      space: 'passedSpace',
      environment: 'dev'
    },
  locale: 'pl'
}
Object.defineProperty(window, 'posNavigatorConfig', { value: posNavigatorConfig })

NPM publising:

1. Increase version in package.json
2. Npm login with proper username and password

   npm login

3. Npm publish (command will trigger prepare npm method which should build files to dist directory)

   npm publish --access=public