vedius-design-tokens

README

This README would normally document whatever steps are necessary to get your application up and running.

Initial setup

Install the project dependencies via the CLI command:

npm install

or with Yarn:

yarn install

Project structure

The project is made of these files and folders:

• /token-generators contains the design tokens input files (in JSON format)
• /templates contains the templates used to generate the output files
• /dist contains the generated output files (in different formats)
• build.js is the script used to generate the output files

Running the project

You can build the design tokens from the /src/ folder using the CLI command:

npm run build
## or
yarn build

Or you can automatically re-build the tokens at every change using the command:

npm run watch
## or
yarn watch

The generated tokens are saved in the /dist folder.

TO-DO Code

• How to run tests
• Deployment instructions

TO-DO Contribution guidelines

• Writing tests
• Code review
• Other guidelines

Who do I talk to?

• @gmantiqueira

References and dependencies

• Style Dictionary