Skip to content

Latest commit

 

History

History
139 lines (86 loc) · 2.89 KB

README.md

File metadata and controls

139 lines (86 loc) · 2.89 KB

iX

Siemens Industrial Experience (iX) monorepo

version npm node yarn MIT License

iX is an open-source design system for designers and developers, to consistently create the perfect digital experience for industrial software products.

Installation

You can find a getting started guide here

Development

Installation

yarn install

Build

yarn build || yarn build --filter=<workspace-name>

Development

yarn start || yarn start --filter=<workspace-name>

Execute unit tests

yarn test

Visual regression testing

Docker cli must be installed on your system
If you execute the visual-regression tests, please be sure to execute the build step before.

yarn build
yarn visual-regression

Documentation

Serve documentation locally

yarn start --filter=documentation

Release

yarn release

Project structure

Package core

Contains all styles and the webcomponents.

published as @siemens/ix

Package react

Contains the wrapper components for react.

published as @siemens/ix-react

Package angular

Contains the wrapper components for angular.

published as @siemens/ix-angular

Package html-test-app, react-test-app and angular-test-app

Contains a playground application to explore and test ix components. Inside the x-test-app's are also the preview source code for the documentation. (src/preview-examples)

This preview-examples will be generated into markdown files and will copied into ./packages/documentation/docs/auto-generated/previews.

Not published

Package documentation

Contains the documentation.

Package aggrid

Contains the brand and classic theme for the aggrid library

published as @siemens/ix-aggrid

Git hooks via husky

Our pipeline lints each commit pushed to remote. To verify that you don't need to rebase existing commits please install our git hooks.

# Activate hooks
npx husky install
# or
yarn husky install

🤝 Contributing

Contributions, issues and feature requests are welcome!

👨‍💻 Maintainers

📝 License

Copyright © 2022 Siemens AG.

This project is MIT licensed.