1.0.0 • Published 3 years ago

utq-poc v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

Getting Started


The first time, you need to customize the config.json file before the first "initial commit". After that, you have configured the project for use with generators.


Install dependencies:

npm install && npm run init

To start storybook for developing:

npm start

To build the ui-kit library, run:

npm run build

To use the generator, run:

npm run generate

Need help? Check out the docs here.

Themes

The themes are configured through custom-properties, available in the themes folder.

We have a specific scss file for each component in scss/04_components.

And we have a specific file of internal variables in each component, which must be configured using public variables.

Autogenerate code

In this project, the generation of the iconsFont is automated, it's simple, you only need to put the svgs in the assets/icons folder and restart the server.

Initial docs

In this project, we have self-generation of visual documentation of the assets, and a getStarted with useful information to use storybook.

Angular formGroups

In order for our components to work correctly with formGroups, we must configure the data types that our components handle.

We can do this in the angular-proxy.ts file

The official documentation

Configuration example