claromentis-design-system
v0.0.1
Published
Claromentis Design System
Downloads
5
Readme
Claromentis Component Library
A library of Claromentis web components.
Dependencies
Documentation
TODO
- Settle on a name for the Design System
- “Clarity” - Nice simple name derive from “Claromentis” bit like “Metro” or “Material Design”
- “Brighton” - Nice homage to the location of our HQ. It shows the diversity, rich & colourful nature of our town which is also reflection to our company culture.
- “Meikai” - “Clarity” in Japanese also has meaning of brightness & understanding.
- “CD” - Just like CLC it has abstract and multiple meaning such as “Claromentis Design” “Compact Design” “Clear Design” “Culture by Design” “Creative Design .. etc
- Flesh out the readme and/or introduce a
CONTRIBUTING.md
contribution guide
Getting started
Install dependencies
Install Node v8.x or higher.
npm install
Run the development server
npm start
Run the development server with ES5 compatibility
This is useful for testing compatibility with browsers that don't yet fully support the HTML5 specs for Web Components.
npm start --es5
Build the component library and documentation
npm run build
Run tests
npm test
Building components
Visit the Stencil documentation to learn how to build Web Components using Stencil.
Naming components
When creating new components, use the cla-
prefix for their tag name. For example: <cla-button>
.