[![node >= 16.16.0](https://img.shields.io/badge/node-%3E%3D16.16.0-brightgreen)](https://nodejs.org/)
[![BSI Studio >= 1.0.0](https://img.shields.io/badge/BSI%20Studio-%3E%3D1.0.0-brightgreen)](https://www.bsi-software.com/cx)
[![BSI CX >= 1.3.0](https://img.shields.io/badge/BSI%20CX-%3E%3D1.3.0-brightgreen)](https://www.bsi-software.com/cx)
[![Latest available version](https://img.shields.io/github/v/tag/bsi-software/bsi-cx-design-build?label=npm)](https://github.com/bsi-software/bsi-cx-design-build/releases)

[![Open GitHub issues](https://img.shields.io/github/issues/bsi-software/bsi-cx-design-build)](https://github.com/bsi-software/bsi-cx-design-build/issues)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/w/bsi-software/bsi-cx-design-build)](https://github.com/bsi-software/bsi-cx-design-build/commits)
[![GitHub last commit](https://img.shields.io/github/last-commit/bsi-software/bsi-cx-design-build)](https://github.com/bsi-software/bsi-cx-design-build/commits)
[![GitHub contributors](https://img.shields.io/github/contributors/bsi-software/bsi-cx-design-build)](https://github.com/bsi-software/bsi-cx-design-build/graphs/contributors)

# @bsi-cx/design-build

Build design ZIP files for BSI CX using a standard Webpack build. Checkout the documentation
on [GitHub Wiki](https://github.com/bsi-software/bsi-cx-design-build/wiki) or visit
the [BSI Software](https://www.bsi-software.com/cx) website for more information about BSI CX. If you need more
information about BSI CX designs, you can read our [online documentation](https://bsi-software.github.io/bsi-cx-docs/).
To start a new BSI CX design project, we recommend you to use
our [master template web](https://github.com/bsi-software/bsi-cx-design-master-template-web). Which provides a complete
template for the web (batteries included). For emails, you can use
the [master template email](https://github.com/bsi-software/bsi-cx-design-master-template-email). If you like so start
from scratch instead, checkout our
[scaffold design](https://github.com/bsi-software/bsi-cx-scaffold-design).

## Requirements

To use this package you have to fulfill the following requirements:

* [Node](https://nodejs.org/) >= 16.16.0
* [NPM](https://nodejs.org/) >= 8.11.0
* A code editor e.g. [Visual Studio Code](https://code.visualstudio.com/), [IntelliJ](https://www.jetbrains.com/idea/)
  or [Web Storm](https://www.jetbrains.com/webstorm/)
* To test your design, you need access to [BSI CX](https://www.bsi-software.com/cx)

## Installation

Fulfill the requirements and run the following command in your project folder:

````shell script
npm install --save-dev @bsi-cx/design-build
````

Or add the following lines to the `devDependencies` section in your `package.json`:

````json
"@bsi-cx/design-build": "^1.0.0"
````

## Documentation

Checkout the [Wiki](https://github.com/bsi-software/bsi-cx-design-build/wiki) for more information on this package and
how to use it.

## Issues

If you have any problems using this package or found a bug,
please [create a new issue](https://github.com/bsi-software/bsi-cx-design-build/issues) in this repository on GitHub.

## Contributing

If you like to contribute to this project, feel free to fork it and create a pull request. For further information,
checkout our [contribution guideline](https://github.com/bsi-software/bsi-cx-design-build/wiki/Contributing) in the
Wiki.