design-framework v1.0.1
Forge Design Framework
This Material-UI framework was bootstrapped with Docz. There are two primary outputs, an importable module containing all of the modified or skinned Material components and a static documentation site that can be deployed after a local build.
Project Setup
This repo uses nvm
for node and yarn
for dependency management. Before starting development, please install nvm and yarn. The specified node version is 10.16.0
.
Once those are installed, please run nvm use
followed by yarn
or yarn install
inside
the project folder to download the necessary dependencies.
Available Scripts
yarn start
The primary local development command. This is a psuedonym for the nodemon --exec 'node tsc-build.js && yalc publish --push --changed' --ext ts,tsx --watch src --ignore build,.yalc,yalc.lock
.
This requires a global install of yalc and assumes you are using it for local development in other projects. On file change, this rebuilds and then publishes the package to yalc, pushing to all projects currently using it to force a rebuild.
Install yalc globally by running yarn global add yalc
. In other projects, where you want to override the package.json github dependency, run yalc link design-framework
and the rest should just work with yarn start
.
yarn build
Runs tcs
to generate a build
directory for consumption when imported into other projects.
yarn lint
Runs eslint
on all src files, excluding .mdx
.
yarn lint:mdx
Runs eslint
on .mdx
files in the src directory.
yarn test
Launches the test runner in the interactive watch mode.
yarn test-coverage
Runs test suite and computes coverage statistics.
yarn coverage
Runs test suite and opens coverage report in browser.
4 years ago