# dos-components

> custom component library created by denisos

Latest version **0.0.5** (published 2022-04-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install dos-components
pnpm add dos-components
yarn add dos-components
bun add dos-components
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2022-04-28 |
| First published | 2022-04-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 88.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | github.com/denisos |
| Maintainers | denisullz |

## Links

- npm: https://www.npmjs.com/package/dos-components
- npm.io page: https://npm.io/package/dos-components

## Recent versions

- 0.0.5 (latest) — 2022-04-28
- 0.0.4 — 2022-04-28
- 0.0.3 — 2022-04-28
- 0.0.2 — 2022-04-28
- 0.0.1 — 2022-04-28

## README

# dos-components
Custom component library I built using tech below. Deployed to npm so can be installed and used in your app.

In most cases its better to theme & customize a pre-built such as material design than build your own from scratch (because it's a lot of effort). But I wanted to use this as a learning opportunity and build out my own component library and reuse in my apps.

Technology used
* react
* typescript
* styled-components
* storybook
* jest
* rollup - module bundler

## Using

### Install 
`yarn add dos-components`

### usage
```
import { Button } from 'dos-components';


<Button primary>Ok</Button>
<Button primary disabled>Ok disabled</Button>
<Button size="small">Ok small</Button>

```

## developing

### install
`nvm use`

`yarn`

### build
`yarn run build`

### run tests


### run storyboard
`yarn storybook`


## deploy to npm
* login to npm
* in root folder `npm publish`

To update on npm 
* `npm version major` or  `npm version minor` or `npm version patch`
* `yarn run publish`  builds and publishes

checkout package `npm pack`

### to dos
* add more components and tests
* define colors etc. in common json file, import and use. use something like style-dictionary to manage the tokens
*

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