# fa-design-system

> Forensic Architecture's React component library

Latest version **0.2.0** (published 2020-09-07) · Do No Harm license · 0 weekly downloads

## Install

```sh
npm install fa-design-system
pnpm add fa-design-system
yarn add fa-design-system
bun add fa-design-system
```

## 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.2.0 |
| Published | 2020-09-07 |
| First published | 2020-09-07 |
| Weekly downloads | 0 |
| License | Do No Harm |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Maintainers | zaci |

## Links

- npm: https://www.npmjs.com/package/fa-design-system
- Repository: https://github.com/forensic-architecture/design-system
- Homepage: https://github.com/forensic-architecture/design-system#readme
- Issues: https://github.com/forensic-architecture/design-system/issues
- npm.io page: https://npm.io/package/fa-design-system

## Recent versions

- 0.2.0 (latest) — 2020-09-07
- 0.1.1 — 2020-09-07
- 0.1.0 — 2020-09-07

## README

## Scripts

- `npm run start:app`: Starts the Create React App application, which enables local testing of our NPM-published component library.
- `npm run start:storybook`: Runs an instance of Storybook, for easier component-driven development.
- `npm run test`: Runs component tests using Enzyme and Jest.
- `npm run build:lib`: Builds our component library using Rollup (anything inside `src/lib/` into the `dist` folder)
- `npm run build:storybook`: Generates static files and a `storybook-static` folder for external consumption of our design system. This will be continuously deployed through Netlify at [design.forensic-architecture.org]()

### Library building and testing with Rollup

Run `npm run build:lib` from the root folder — this will generate a `dist/` folder, along with styles. Then, run:

```
cd dist/
npm link
cd ..
npm link design-system
```

to create an alias and be able to require components from the component library like so: `import {Button} from 'design-system'`. Test that this works on `src/App.js`.

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