# therbert-component-library

> Component and helper Library

Latest version **1.0.1** (published 2018-01-17) · 0 weekly downloads

## Install

```sh
npm install therbert-component-library
pnpm add therbert-component-library
yarn add therbert-component-library
bun add therbert-component-library
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-01-17 |
| First published | 2018-01-17 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | Tom Herbert |
| Maintainers | therbert |

## Links

- npm: https://www.npmjs.com/package/therbert-component-library
- Repository: https://github.com/taherbert/component-library
- Homepage: https://github.com/taherbert/component-library#readme
- Issues: https://github.com/taherbert/component-library/issues
- npm.io page: https://npm.io/package/therbert-component-library

## Dependencies (1)

- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.26.0

## Recent versions

- 1.0.1 (latest) — 2018-01-17

## README

# UCD Advancement Services Module Library

Development, testing, deployment, and version control environment for React components. Built using:

* Storybook
* Lerna
* Jest + Enzyme
* Babel (via create-react-app)
* React

## Commands

#### Start storybook
`npm start`

Starts a hot-module-reloading environment for developing and testing React components. Defaults to localhost:9001.

#### Run Jest tests
`npm run test`

Executes all Jest tests, checking for files ending with *.spec.js* or *.test.js*. Defaults to include coverage report in verbose mode.

#### Bootstrap modules
`npm run bootstrap`

Automatically installs all modules' dependencies inside of the monorepo, utilizing Lerna's *bootstrap* command.

#### Build modules
`npm run build`

 Installs dependencies, babelifies, minifies, etc. for each module inside of the monorepo, utilizing Lerna's *exec* command. Uses Babel to transpile ES6 code into ES5.

**Detailed steps**
1. Run eslint to check for syntax errors
2. Run prettier to format code properly
3. Compile code with babel and minify
4. Pipe into the "dist" folder
5. Ignore any .spec.js or .story.js files

 #### Build storybook
 `npm run build-storybook`

 Builds the entire storybook into a publishable user interface. This package can be dropped into a web application to enable an interactable website that contains the current state of the monorepo's components.

 #### Publish modules
 `npm run publish`

 Installs, builds, and publishes all modules (checking for changes) to npm and github. Will prompt for a new version number for each module, following semver conventions. Requires and existing active login session to publish to npm, utilizing `npm login` or `npm adduser`.

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