Monorepository to manage all the adidas YARN Design System plugins for adidas only use.
Each plugin extends adidas YARN Design System library by adding the plugin main class as part of .yarn main class.
The available plugins are shown on the documentation page.
The idea of the plugins is to add customizations for either third party libraries or non core components directly in YARN source code.
This repository contains different plugins which are independent packages. It means that all these packages are published independently but managed all together. Lerna is the tool used to manage them.
NodeJS/NPM are required to work with the repository.
Install a specific package in production mode (installation of each configuration):
npm install PACKAGE_NAME[@VERSION]
The required dependencies of each package are listed in their own package.json file as either dependency or peer dependency.
Specific instructions about how to use the configurations are placed in the README.md file of each package.
In development mode (dependencies of the main package):
npm install
npm run setup
Lerna manages the scripts of the available packages all together:
- Build:
npm run build - Lint:
npm run lint
Note: all the packages must have these two scripts with their specific commands.
Lerna is in charge of publishing the packages, it requires that every single package has to set the version accordingly.
npm run lerna:publish
Check the contributor list and you will be welcome if you want to contribute.
Check out the CONTRIBUTING.md to know how to contribute to this project.
© adidas AG
adidas AG publishes this software and accompanied documentation (if any) subject to the terms of the MIT license with the aim of helping the community with our tools and libraries which we think can be also useful for other people. You will find a copy of the MIT license in the root folder of this package. All rights not explicitly granted to you under the MIT license remain the sole and exclusive property of adidas AG.
NOTICE: The software has been designed solely for the purpose of giving some CSS classes to customize the ChoicesJS Stencil Web Component with the adidas style. The software is NOT designed, tested or verified for productive use whatsoever, nor or for any use related to high risk environments, such as health care, highly or fully autonomous driving, power plants, or other critical infrastructures or services.
If you want to contact adidas regarding the software, you can mail us at software.engineering@adidas.com.
For further information open the adidas terms and conditions page.