[![npm](https://img.shields.io/npm/v/@holaluz/kalimotxo.svg)](https://img.shields.io/npm/v/@holaluz/kalimotxo.svg)
[![deploy](https://github.com/holaluz/kalimotxo/workflows/Build%20and%20Deploy/badge.svg)](https://github.com/holaluz/kalimotxo/workflows/Build%20and%20Deploy/badge.svg)
[![publish](https://github.com/holaluz/kalimotxo/workflows/Publish%20NPM%20package/badge.svg)](https://github.com/holaluz/kalimotxo/workflows/Publish%20NPM%20package/badge.svg)

![kalimotxo](kalimotxo.png)

# Kalimotxo

Kalimotxo is a repository of front end [organisms](https://bradfrost.com/blog/post/atomic-web-design/#organisms).

The storybook with component examples is available [here](https://holaluz.github.io/kalimotxo/).

The NPM package is available [here](https://www.npmjs.com/package/@holaluz/kalimotxo/).

## About Kalimotxo

- Built on top of [Vite and Vue](https://vitejs.dev/).
- Depends on [Margarita](https://github.com/holaluz/margarita)
- Uses [Storybook](https://github.com/storybooks/storybook) to develop, showcase, and test each component.
- Unit testing based on [Jest](https://jestjs.io/) and [Vue Testing Library](https://github.com/testing-library/vue-testing-library).

## Installation

Clone the repo and install node dependencies:

```bash
$ npm install
```

## Useful commands

```bash
# run storybook
$ npm start

# run unit tests
$ npm test

# run unit tests with watch mode enabled
$ npm run test:watch
```

## Deployment and versioning

Every commit into main automatically triggers GH pages deploy and Semantic Release check.

Kalimotxo uses [Semantic Release](https://github.com/semantic-release/semantic-release/) to handle the release pipeline.

Triggering a new release will create the associated Git tag, the GitHub release entry, and publish a new version on [npm](https://www.npmjs.com/package/@holaluz/margarita).

In order to trigger a new version, make sure you add the appropriate prefix and message to the squashed commit. It is based on the [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). In short:

```bash
# Creates a patch release (v1.0.0 -> v1.0.1)
> fix: commit message

# Creates a feature release (v1.0.0 -> v1.1.0)
> feat: commit message

# Creates a breaking release (v1.0.0 -> v2.0.0)
> fix: commit message
>
> BREAKING CHANGE: explain the breaking change # "BREAKING CHANGE:" is what triggers the breaking release
```

There's no need to overcomplicate things here. Keep it simple: `fix`, `feat`, and `chore` (plus `BREAKING CHANGE`) should be enough for now.