Starton - Design Token - Theme builder

React UI template is a template used for ui libraries using MUI, Emotion and React.

Requirements

You will need :

• NodeJS (we recommend the use of nvm)
• Yarn or NPM

Installation

To install the project, first clone the repository and go inside project directory, then :

• With yarn :

  $ yarn add -D @starton/design-token-theme-builder

• With NPM :

  $ npm install -D @starton/design-token-theme-builder

Generate your theme

First you need to configure your theme builder with theme-builder.config.json :

• src: You can use local path ("./design-token.json") or you can use remote path ("https://files.domain.com/design-token.json")
• path: output folder path
• calcs: Select desired calcs you want to merge, compute and transform
• transformer: Choose output format (default: mui)

Add in your package.json your script command:

{
  // ...
  scripts: {
    // ...
    "theme-build": "starton-theme-build"
  },
  // ...
}

Tip: We recommend you add the theme generation in your pre build and pre start scripts.

Start your generation:

• With yarn :

  $ yarn theme-build

• With NPM :

  $ npm run theme-build

Documentation

Find out more on how to use Starton in our Documentation

Contributing

Contributions are always welcome!

See Contributing for ways to get started.

Please adhere to Starton's Code of Conduct.

License

Apache License 2.0

Authors

• Starton [email protected]
• Calixte DE TOURRIS [email protected]