# mmc-components-library

> 1. Set your project to use whatever node.js version is referenced in the package.json ![nodejs setup](./markdown-images/node.png) 2. Set Webstorm to use the ESLint settings of the project ![nodejs setup](./markdown-images/eslint

Latest version **0.0.6** (published 2021-04-22) · 0 weekly downloads

## Install

```sh
npm install mmc-components-library
pnpm add mmc-components-library
yarn add mmc-components-library
bun add mmc-components-library
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2021-04-22 |
| First published | 2021-04-22 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | 15.14.0 |
| Dependencies | 12 |
| Unpacked size | 2.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | ntoporcov |

## Links

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

## Dependencies (12)

- [vue](https://npm.io/package/vue.md) ^3.0.5
- [core-js](https://npm.io/package/core-js.md) ^3.6.5
- [ts-jest](https://npm.io/package/ts-jest.md) ^26.5.5
- [tailwindcss](https://npm.io/package/tailwindcss.md) ^2.1.1
- [@fullhuman/postcss-purgecss](https://npm.io/package/@fullhuman/postcss-purgecss.md) ^4.0.3
- [@fortawesome/vue-fontawesome](https://npm.io/package/@fortawesome/vue-fontawesome.md) ^3.0.0-3
- [@fortawesome/pro-light-svg-icons](https://npm.io/package/@fortawesome/pro-light-svg-icons.md) ^5.15.3
- [@fortawesome/pro-solid-svg-icons](https://npm.io/package/@fortawesome/pro-solid-svg-icons.md) ^5.15.3
- [@fortawesome/fontawesome-svg-core](https://npm.io/package/@fortawesome/fontawesome-svg-core.md) ^1.2.35
- [@fortawesome/free-solid-svg-icons](https://npm.io/package/@fortawesome/free-solid-svg-icons.md) ^5.15.3
- [@fortawesome/pro-duotone-svg-icons](https://npm.io/package/@fortawesome/pro-duotone-svg-icons.md) ^5.15.3
- [@fortawesome/pro-regular-svg-icons](https://npm.io/package/@fortawesome/pro-regular-svg-icons.md) ^5.15.3

## Recent versions

- 0.0.6 (latest) — 2021-04-22
- 0.0.5 — 2021-04-22
- 0.0.4 — 2021-04-22
- 0.0.3 — 2021-04-22
- 0.0.2 — 2021-04-22
- 0.0.1 — 2021-04-22

## README

## IDE Setup
1. Set your project to use whatever node.js version is referenced in the package.json
<br><br>
   ![nodejs setup](./markdown-images/node.png)
2. Set Webstorm to use the ESLint settings of the project
   <br><br>
   ![nodejs setup](./markdown-images/eslint.png)
3. Set Webstorm to use the Prettier Settings of the project
   <br><br>
   ![nodejs setup](./markdown-images/prettier.png)
4. Set Webstorm to use PostCSS as the dialect of stylesheet
   <br><br>
   ![nodejs setup](./markdown-images/postcss.png)

## Key Components: 
The tooling setup for this project loosely follows [this guide.](class="max-w-md mx-auto")

#### Runtimes / Package Manager
1. NodeJS - Server side JavaScript Interpreter
2. Yarn - Modern package manager to replace NPM that supports a better CLI and parallelism 

#### Dev Server / Bundler 
1. Vite - Dev server / bundler (Uses ES6 modules for development / Hot Module Reload, uses Parcel for production bundles.)

#### JavaScript Frameworks
1. VueJS 3.0 - Minimal front-end framework
2. TypeScript - Language that provides static typing for JS and transpiles to it. 

#### Linting / Formatting
1. ESLint - Semantic analysis
2. Prettier - Formatting

#### Styles
1. PostCSS - Modular CSS Processing framework that allows the installation of plugins to add features. We're using the PreCSS plugin
which mimics SCSS (nested styles, variables, etc)
2. TailwindCSS - Utility based CSS framework that has a predefined list of classes that you use to style your elements.

#### Testing / Continuous Integration
1. Jest - Standard JS unit testing library
2. Vue Testing Library - VueJS component testing library
3. Cypress.io - End-to-End (E2E) testing framework
4. Husky / Lint-staged - Git hooks tool that runs Prettier, ESLint, and Jest before commits to enforce code quality

#### Component Driven Design
1. Storybooks - Environment to develop components in isolation and provide documentation for them.

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