Home Explore Help
Sign In
cturan
/
vendure
mirror of https://github.com/vendure-ecommerce/vendure
1
0
Fork 0
Files Issues 0 Wiki
Tree: b86da59632
Branches Tags
vendure
/
packages
/
admin-ui
Michael Bromley c9cf090828 chore: Add Publish & Install workflow to CI 5 years ago
..
e2e 38e94590dc refactor(admin-ui): Move admin-ui into packages dir 6 years ago
scripts 97b5aed8d8 refactor(admin-ui): Create new lazy-loaded SystemModule 5 years ago
src 5045ed0e69 chore: Publish v0.12.1 5 years ago
.gitignore fe72c41e7c feat(admin-ui): Improved ui extension development API & architecture 5 years ago
.npmignore 1622b146d7 refactor(admin-ui): Split admin ui into library of sub-packages 5 years ago
README.md 32a15c906d docs: Add some more info on contributing 5 years ago
angular.json 1622b146d7 refactor(admin-ui): Split admin ui into library of sub-packages 5 years ago
package.json c9cf090828 chore: Add Publish & Install workflow to CI 5 years ago
tsconfig.json 97b5aed8d8 refactor(admin-ui): Create new lazy-loaded SystemModule 5 years ago
tsconfig.lib.json 1622b146d7 refactor(admin-ui): Split admin ui into library of sub-packages 5 years ago
tsconfig.lib.prod.json f8829400fc refactor(admin-ui, ui-devkit): Minimally working devkit build 5 years ago
tslint.json bc35c2517b feat(admin-ui): Update Angular to v9 5 years ago
yarn.lock 38e94590dc refactor(admin-ui): Move admin-ui into packages dir 6 years ago

README.md

Vendure Admin UI

This is the administration interface for Vendure.

It is an Angular application built with the Angular CLI.

The UI is powered by the Clarity Design System.

Structure

Library

The Admin UI is structured as an Angular library conforming to the ng-packagr format. This library is what is published to npm as @vendure/admin-ui. The libary consists of a set of modules which are accessible from consuming applications as sub-packages:

  • @vendure/admin-ui/core
  • @vendure/admin-ui/catalog
  • @vendure/admin-ui/orders

etc. These library packages are located at ./src/lib

When built with yarn build, the output will be located in the ./package sub directory. This is also the root of the published npm package.

Application

In addition to the library, there is also a full application located at ./src/app. This application is used both during development of the Admin UI, and also as the "default" Admin UI without any UI extensions, as provided as the default by the admin-ui-plugin.

Localization

Localization of UI strings is handled by ngx-translate. The translation strings should use the ICU MessageFormat.

Translation keys are automatically extracted by running:

yarn extract-translations

This will add any new translation keys to the default language file located in ./src/lib/static/i18n-messages/en.json.

To extract translations into other language, run the same command as specified in the extract-translations npm script, but substitute the "en" in "en.json" with the ISO 639-1 2-character language code for that language.