@solfacil/girassol/README.md

Girassol design system

<div align="center">
  <img style="width: 300px" src="https://girassol.pages.dev/public/logo.svg" />
</div>

![Release](https://github.com/solfacil/girassol/actions/workflows/release.yml/badge.svg)

![Production](https://github.com/solfacil/girassol/actions/workflows/production.yml/badge.svg)


<div style="flex">
  <a href="https://npm.im/@solfacil/girassol" target="_blank">
    <img src="https://img.shields.io/npm/v/@solfacil/girassol.svg" />
  </a>

  <a href="https://npm.im/@solfacil/girassol" target="_blank">
    <img src="https://img.shields.io/npm/types/@solfacil/girassol.svg" />
  </a>

  <a href="https://npm.im/@solfacil/girassol" target="_blank">
    <img src="https://badgen.net/badge/node/v16.17/74b758?icon=npm" />
  </a>

  <a href="https://npm.im/@solfacil/girassol" target="_blank">
    <img src="https://badgen.net/badge/typescript/v4.9.4/1081c2?icon=typescript" />
  </a>

  <a href="https://npm.im/@solfacil/girassol" target="_blank">
    <img src="https://badgen.net/badge/vue.js/v3.2.45/42b883" />
  </a>

  <a href="https://bundlephobia.com/result?p=@solfacil/girassol" target="_blank">
    <img src="https://badgen.net/bundlephobia/min/@solfacil/girassol" />
  </a>

  <a href="https://bundlephobia.com/result?p=@solfacil/girassol" target="_blank">
    <img src="https://badgen.net/bundlephobia/minzip/@solfacil/girassol" />
  </a>

  <a href="https://bundlephobia.com/result?p=@solfacil/girassol" target="_blank">
    <img src="https://badgen.net/bundlephobia/tree-shaking/@solfacil/girassol" />
  </a>
</div>


- 👨‍💻 Develop in production
- ⚡️ Nuxt/Vue support
- 🧪 Fully tested with unit tests

# 📝 Documentação

Para compreender melhor o design system e para saber quais features e componentes estão disponíveis, acesse a **<a href="https://girassol.pages.dev/" target="_blank">Documentação oficial do Girassol</a>**

## 🔨 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

- [Vue 3](https://vuejs.org/)
- [TypeScript](https://www.typescriptlang.org/docs/handbook/2/basic-types.html)
- [VueUse](https://vueuse.org/)
- [WindiCSS](https://windicss.org/)
- [Vitest](https://vitest.dev/)
- [Testing library](https://testing-library.com/docs/)

# 📦️ Instalação

Basta executar:
```bash dark
yarn add @solfacil/girassol
```

e colocar no `scripts` dentro do `package.json` para ter acesso ao nosso CLI:

```json dark
{
  "scripts": {
    "girassol-cli": "girassol-cli"
  }
}
```

# 👷 Como usar

Após fazer o processo de instalação, você deve executar `yarn girassol-cli generate:plugin`.

Isto irá configura o plugin no seu projeto e estará pronto para usar, sem a necessidade de importar os componentes, só necessitando importar os composables com a necessidade.

# Licença

<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/npm/l/buefy.svg?logo=github" /></a>

Released under the MIT [License](https://opensource.org/licenses/MIT). Copyright (c) Solfácil.