# cuida_v3_test

> A design system built by Sysvale, using storybook and Vue components

Latest version **3.0.0-alpha.5** (published 2022-08-27) · 0 weekly downloads

## Install

```sh
npm install cuida_v3_test
pnpm add cuida_v3_test
yarn add cuida_v3_test
bun add cuida_v3_test
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.0-alpha.5 |
| Published | 2022-08-27 |
| First published | 2022-08-24 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 16.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 23 |
| Maintainers | rafael_dias |

## Links

- npm: https://www.npmjs.com/package/cuida_v3_test
- Repository: https://github.com/Sysvale/cuida
- Homepage: https://github.com/Sysvale/cuida#readme
- Issues: https://github.com/Sysvale/cuida/issues
- npm.io page: https://npm.io/package/cuida_v3_test

## Dependencies (1)

- [vue](https://npm.io/package/vue.md) ^3.2.37

## Recent versions

- 3.0.0-alpha.5 (latest) — 2022-08-27
- 3.0.0-alpha.4 — 2022-08-27
- 3.0.0-alpha.3 — 2022-08-26
- 3.0.0-alpha.2 — 2022-08-26
- 3.0.0-alpha.1 — 2022-08-24

## README

<p align="center">
  <a href="https://sysvale.github.io/cuida">
    <img src="https://sysvale.github.io/cuida/static/media/CuidaTempLogo.f4adb1cc.png" alt="Cuida logo" width="350" />
  </a>
</p>

<div align="center">
  <p align="center">A design system built by Sysvale, using storybook and Vue components</p>
  <p align="center">https://sysvale.github.io/cuida/</p>
</div>

## Instalando

- O Cuida pode ser instalado com o npm:

```bash
$ npm i @sysvale/cuida;
```

## Usando

- Instale o bootstrap-vue como dependência:

```bash
$ npm i @sysvale/cuida;
```

- Para usar o bootstrap-vue, importe a biblioteca no seu entry point, provavelmente vai ser seu main.js ou app.js:

```js
import BootstrapVue from "bootstrap-vue";
import "bootstrap/dist/css/bootstrap.css";
import "bootstrap-vue/dist/bootstrap-vue.css";
```

- Instale o bootstrap-vue com:

```js
$ npm install bootstrap-vue bootstrap;
```

- Para usar o cuida, importe a biblioteca no seu entry point, provavelmente vai ser seu main.js ou app.js:

```js
import Cuida from "@sysvale/cuida";
```

- E instale o Cuida:

```js
Vue.use(Cuida);
```

- Agora para utilizar os componentes, basta usá-los no seu template. Como exemplo, para usar a
  [Badge](https://sysvale.github.io/cuida/?path=/docs/componentes-display-badge--badge):

```html
<cds-badge variant="gray"> Conteúdo </cds-badge>
```

- Para utilizar os tokens, importe-os na sua tag script.

```html
<style lang="scss" scoped>
  @import 'node_modules/@sysvale/cuida/dist/@sysvale/tokens.scss';
  ...
</style>
```

## Desenvolvendo

### Configurando o projeto

- Clone o repositório:

```bash
$ git clone https://github.com/Sysvale/cuida.git
```

- Instale as dependências e suba o container docker:

```bash
$ docker-compose up -d
```

A aplicação estará disponível na porta `6006`, em [http://localhost:6006/](http://localhost:6006).

- Caso não queira usar docker, instale as dependências com:

```bash
$ npm i
```

### Executando o Cuida

- Após a execução do comando `docker-composer up -d` a aplicação já estará rodando no [http://localhost:6006/](http://localhost:6006)
  .
- Ou alternativamente, sem o docker, rode apenas:

```bash
$ npm run storybook
```

### Testando-o

- Utilizando o docker:

```bash
$ docker-compose exec cuida npm run test
```

ou

```bash
$ ./on-server.sh npm run test
```

- Sem o docker:

```bash
$ npm run test
```

## Contribuindo

Para informações sobre como contribuir com o projeto, acesse o [CONTRIBUTING.MD](https://github.com/Sysvale/cuida/blob/master/CONTRIBUTING.md)

---
_Source: https://npm.io/package/cuida_v3_test · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._