Metazen-frontend-sdk NPM

Metazen Frontend SDK

This repo includes an example of the SDK's usages, which can be run with npm run start. It is designed to assist integration.

Authentication is done with standard OIDC flow, as implemented by Keycloak.

Installation

Install the dependency:

npm i --save <TBD package name>

Import:

import { <component> } from '<TBD final package name>'

The package may be the frontend-sdk or tentatively, just the frontend-components-sdk.

KeyCloak

This needs to be run in conjunction with Keycloak server.

For information how to setup local Keycloak server refer to: https://gitlab.int.hextech.io/infrastructure/keycloak

Local Keycloak configuration is at keycloak.json.

UI

Use Material UI V5.

Prerequisites

You'll need to have Node 12.0.0 or up. We recommend upgrading to the LTS version of NodeJS available at https://nodejs.org/. You can also use nvm (macOS/Linux) or nvm-windows to switch Node versions between different projects.

Available Scripts

Please only use npm.

In the project directory, you can run:

`npm start`

Runs the app in the development mode.\ Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.\ You may also see any lint errors in the console.

# enable connects to fake api server in .env.local or any .env file you are using
REACT_APP_FAKE_API_SERVER=true

# modify requests that you are interested in local_mock_server/swagger.yaml
# install prism if you haven't, see local_mock_server/run.sh

# run local_mock_server
npm install @stoplight/prism-cli -g
npm run start:mock

`npm test`

Launches the test runner in the interactive watch mode.\ See the section about running tests for more information.

`npm run build`

Builds the app for production to the build folder.\ It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\ Your app is ready to be deployed!

See the section about deployment for more information.

`npm run eject`

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.