@careeman/aurora-web v0.0.3

Careem's Aurora Web Design System

This is Careem's new design system for web which offers a variety of components to be integrated by itself & third-party/customers in their own applications.

This design system contains components which are made using StencilJs

About Stencils:

Stencil

Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Stencil components are just Web Components, so they work in any major framework or with no framework at all.

Getting Started

To use this library clone the repository first.

and run:

yarn install
#IGNORE: npx tailwindcss -i ./src/directives.css -o ./www/tailwind.css --watch
yarn dev

Using Storybook

To view the components & see their example code run:

yarn storybook

To build the component for production, run:

yarn build

And then use the components by embedding the build script.