mmc-components-library
v0.0.6
Published
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
Downloads
4
Readme
IDE Setup
- Set your project to use whatever node.js version is referenced in the package.json
- Set Webstorm to use the ESLint settings of the project
- Set Webstorm to use the Prettier Settings of the project
- Set Webstorm to use PostCSS as the dialect of stylesheet
Key Components:
The tooling setup for this project loosely follows [this guide.](class="max-w-md mx-auto")
Runtimes / Package Manager
- NodeJS - Server side JavaScript Interpreter
- Yarn - Modern package manager to replace NPM that supports a better CLI and parallelism
Dev Server / Bundler
- Vite - Dev server / bundler (Uses ES6 modules for development / Hot Module Reload, uses Parcel for production bundles.)
JavaScript Frameworks
- VueJS 3.0 - Minimal front-end framework
- TypeScript - Language that provides static typing for JS and transpiles to it.
Linting / Formatting
- ESLint - Semantic analysis
- Prettier - Formatting
Styles
- 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)
- TailwindCSS - Utility based CSS framework that has a predefined list of classes that you use to style your elements.
Testing / Continuous Integration
- Jest - Standard JS unit testing library
- Vue Testing Library - VueJS component testing library
- Cypress.io - End-to-End (E2E) testing framework
- Husky / Lint-staged - Git hooks tool that runs Prettier, ESLint, and Jest before commits to enforce code quality
Component Driven Design
- Storybooks - Environment to develop components in isolation and provide documentation for them.