VLM-UI

VLM-UI is a React based UI kit for VLM Design

Usage

This is not an open source package, it is not released for npm, so vlm-monorepo is required to use it

First clone vlm-monorepo. In the monorepo, the src folder is set to resolve the packages:

package.json

{
    "workspaces": [
        "packages/*",
        "src/*"
    ]
}

Install dependencies

yarn install

Create your own package in /src folder, eg: /src/my-package

import Button from 'vlm-ui/dist/common/src/components/Button'

Import a component

Contribution

If you want to develop the vlm-ui package, you can do it in the following way.

System requirements

NodeJs runnability

Scripts for vlm-ui

Start - this script starts the VLM-UI-WEB package, which contains the documentation, it can be used during development.

npm run "vlm-ui start"

Build - this command builds vlm-ui

npm run "vlm-ui build"

Clean - this command flushes vlm-ui

npm run "vlm-ui clean"

Build and start

After the "build" script is run, wapplr-cli creates a distribution version to "dist" folder. The contents of the dist/common/src/ folder can be used by other packages in the src folder - as mentioned above.

A React based UI kit for VLM Design