Development

To work on the project run yarn install && yarn start to install dependencies and start webpack dev with watch.

How it works

Add!

Usage Example

The project includes an example to test the usage of the scripts.

1. Copy .env.sample into /example and rename to .env
2. Replace the sample values in .env with valid ones
3. If using a different API endpoint to https://dev.api-2.collabur.com, add COLLABUR_API={new endpoint} to .env
4. Run yarn example from the project root

The example/src folder should now include any mapped template files and assets generated by the scripts.

Publishing

The package will be published automatically when a new release is published on Github. This will happen via Github Actions.

Usage

To use the scripts in a design system project:

1. yarn add @collabur/ds-scripts --dev to install the package in your project
2. Paste the following variables into the appropriate .env files, replace the values with real ones:

COLLABUR_DS=designsystem
COLLABUR_DS_BRANCH=master
COLLABUR_ACCESS_TOKEN=abcd.1234

3. Paste the following into a cds.config.yml file in your project root:

ds:
  defaultUnit: rem
  fontDir: src/assets/fonts
  iconDir: src/assets/icons
  brandDir: src/assets/brand
map:
  rootDir: src
  storybookDir: .storybook
  ignore: []
  passes: 1
  targetTag: "###"

4. Add Collabur scripts commands into your package scripts where desired.