# @r3p0x/a9s-component-library

> This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

Latest version **0.1.9** (published 2020-04-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install @r3p0x/a9s-component-library
pnpm add @r3p0x/a9s-component-library
yarn add @r3p0x/a9s-component-library
bun add @r3p0x/a9s-component-library
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.9 |
| Published | 2020-04-29 |
| First published | 2020-04-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 3.6 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | r3p0x |

## Links

- npm: https://www.npmjs.com/package/@r3p0x/a9s-component-library
- npm.io page: https://npm.io/package/@r3p0x/a9s-component-library

## Dependencies (3)

- [rx](https://npm.io/package/rx.md) ^4.1.0
- [@storybook/addon-docs](https://npm.io/package/@storybook/addon-docs.md) ^5.3.17
- [@storybook/preset-create-react-app](https://npm.io/package/@storybook/preset-create-react-app.md) ^2.1.1

## Recent versions

- 0.1.9 (latest) — 2020-04-29
- 0.1.8 — 2020-04-29
- 0.1.7 — 2020-04-29
- 0.1.6 — 2020-04-29
- 0.1.5 — 2020-04-29
- 0.1.4 — 2020-04-28
- 0.1.3 — 2020-04-28
- 0.1.2 — 2020-04-28
- 0.1.1 — 2020-04-27
- 0.1.0 — 2020-04-16

## README

<p align="center">
  <img src='https://i.postimg.cc/htXZN4Dr/logo-outline-light.png' border='0' width='300' alt='logo-outline-light'/>
</p>

<p align="center" style="display: flex;">
  <a href="https://anynines.atlassian.net/jira/software/projects/CHAP/boards/41" style="border-radius: 2px; background-color: #2e2e2e; padding: 4px; display: flex; align-items: center;" target="_blank">
    <img src="https://i.postimg.cc/VvMwnWCp/jira.png'" alt="JIRA" height="30px" />
  </a>
  <a href="https://xd.adobe.com/view/7b554cdc-7a4a-46ab-7bbc-d9f3e178a1f0-0d64/" style="display: flex; align-items: center;" target="_blank">
    <img src="https://i.postimg.cc/6qsJW4m0/prototype.png" alt="XD" height="30px" />
  </a>
  <a href="https://github.com/avarteqgmbh/happy_frontend" style="display: flex; align-items: center;" target="_blank">
    <img src="https://i.postimg.cc/sgZdcVqk/frontend.png" alt="backend" height="30px" />
  </a>
  <a href="https://github.com/avarteqgmbh/happy_backend" style="display: flex; align-items: center;" target="_blank">
    <img src="https://i.postimg.cc/yNQ7HdKQ/backend.png" alt="component-library" height="30px" />
  </a>
</p>

<br/>

# Welcome to happy_component_library

`happy_component_library` is the central repository to manage our UI components. This should lead to a straight forward separation of concerns, so that UI logic keeps within the component library and business logic will be added in the actual application. This way we can guarantee a specific degree of consistency across all our applications, rapidly speed up our development process of frontend applications and even achieve a high degree of customization by overwriting the theme object.

Note: This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Installation

Clone the GitHub Repo locally, then run

```sh
yarn install
```

## Development

In Order to work with the Component Library locally, run npm link for the peer dependencies
found in the package.json. Run the following commands in the <b>component_library-directory </b>
and link the packages from your external repo via:</br>
(<i><b>Info:</b> the external repo and the component_library should be in the same parent folder
</i>)

```sh
npm link ../happy_frontend/node_modules/react
```

```sh
npm link ../happy_frontend/node_modules/styled-components
```

```sh
npm link ../happy_frontend/node_modules/react-router-dom
```
</br>
Run this to build the package (before an update in external repo), important after changing components or other configurations:

```sh
yarn build
```

In the other project-directory, you add the local path of the component-library

```sh
yarn add ../component_library
```

You can now import Components from the Library via
```sh
import { Component } from 'component-library'
```

## Testing

In the project directory, you can run:

Run this to start the storybook application

```sh
yarn run storybook
```

Run this to ensure it is correctly packaged

```sh
yarn start
```

Run this to start the Test Suite

```sh
yarn test
```

Launches the test runner in the interactive watch mode.<br />
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

## Production

You can build the app for production with

```sh
yarn build
```

You can find the build in the `build` folder.<br />
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.<br />
Your app is ready to be deployed!

See the section about [production](https://en.parceljs.org/production.html) for more information.

## Learn More

You can learn more in the [Parcel documentation](https://en.parceljs.org/getting_started.html).

To learn React, check out the [React documentation](https://reactjs.org/).

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