Kompas Web Components

Kompas Web Components is frontend reusable component for Harian Kompas project.

Installation

To start building a new web component using Stencil, clone this repo to a new directory:

git clone https://github.com/pt-kompas-media-nusantara/kompas-web-components.git
cd kompas-web-component

Use

• Node.js version 14
• NPM version 6
• Stencil.js version ^2.5.2

Then run npm install to install Kompas Web Component.

npm install

Usage

Run:

npm start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

To publish to NPM

npm run build
npm login
npm publish --access public --otp=<code>

For detailed explanation on how things work, check out Stencil.js docs.

Implement Component to Another Project

on kompas-web-component run:

cd kompas-web-component
npm start build
npm link

on your project run:

cd project-folder
npm link @kompasid/kompas-web-compoenent

How to develop

• Create component that want to build on /src/components
• Use .ts format (We use TypeScript for functionality)
• Declare every components, states and props (if exist) and run npm run build before npm start to create readme in component directory automatically
• We use Tailwind CSS v2 for styling component, check out Tailwind CSS docs.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT