-
Notifications
You must be signed in to change notification settings - Fork 0
Installation
This chapter describes the minimal requirements to install and use this package.
To use this package you have to fulfill the following requirements:
- Supported operating systems: Windows, Mac and Linux
- Node.js >= 14.17.5
- NPM >= 6.14.14
- A code editor e.g. Visual Studio Code, IntelliJ or Web Storm
Editors like Visual Studio Code, Atom or Sublime are suitable for small projects. For bigger projects we recommend using one of the JetBrains products.
To test your design you need access to an instance of BSI CX.
This section describes the steps to install the package as NPM dependency. If you are interested in contributing to this project, please consider the chapter about contributing to this project.
To install and use this package check first you fulfill the minimal requirements. In order to install
the package navigate to your project's root folder (where your package.json is located and execute the following
command:
npm install --save-dev @bsi-cx/design-buildThis will install the package and all its required dependencies. Your package.json should contain the
following devDependencies afterwards:
"@bsi-cx/design-build": "^1.0.0"Folder Structure
Configuration
Design Specification
Templates
Run the Build
Build Multiple Templates
Legacy Design Format
Hash ZIP Files
Disable Source Maps
Bundle JavaScript Modules
Change the Development Server Port
Add Webpack Rules and Plugins
Copy Additional Files
Copy a Configuration
Customize the Assets Filename
Add File Extensions for Static Assets
Specification
Design
Content Element Group
Content Element
Content Element Part
Dropzones
Extending Dropzones
Style Configuration
HTML Editor Configuration
Websites
Translations
Using Raw Values
Compatible Versions and Designs
Properties
Colors
URLs
Numeric Values
Templates
Include Assets
Include Stylesheets
Include JavaScript
Sample Text Provider
Twig and Handlebars