AdminUiPlugin

AdminUiPlugin

This plugin starts a static server for the Admin UI app, and proxies it via the /admin/ path of the main Vendure server.

The Admin UI allows you to administer all aspects of your store, from inventory management to order tracking. It is the tool used by store administrators on a day-to-day basis for the management of the store.

Installation

yarn add @vendure/admin-ui-plugin

or

npm install @vendure/admin-ui-plugin

Example

import { AdminUiPlugin } from '@vendure/admin-ui-plugin';

const config: VendureConfig = {
  // Add an instance of the plugin to the plugins array
  plugins: [
    AdminUiPlugin.init({ port: 3002 }),
  ],
};

Signature

class AdminUiPlugin implements NestModule {
  constructor(configService: ConfigService, processContext: ProcessContext)
  static init(options: AdminUiPluginOptions) => Type<AdminUiPlugin>;
  async configure(consumer: MiddlewareConsumer) => ;
}

Implements

• NestModule

Members

constructor

init

configure

Contents:

• AdminUiConfig
• AdminUiPluginOptions