UI-Plugins-Client

A JavaScript library to build user plugins for BriteCore UI

Learn more about UI Plugins on our help site

Communication

Please see our contributing guidelines

Getting Started

Installing

• Install by running:

  npm install @britecore/ui-plugins-client
  

• Use in the browser by adding:

  <script src="https://unpkg.com/@britecore/ui-plugins-client@0.9.2/dist/britecore-ui-plugins.js"></script>

  Use the latest <script src="https://unpkg.com/@britecore/ui-plugins-client"></script>

  Use a specific version <script src="https://unpkg.com/@britecore/ui-plugins-client@0.9.2"></script>

Testing

1. Install all the dependencies and test:

   npm install
   npm test
   # npm run coverage
   # yarn install

2. Spin up the development server:

   npm run serve
   # yarn serve

3. Alternatively, you can run this command to build the project and serve it in another way:

   npm run build
   # yarn build