Important: Storybook temp removed.
You can visit the full documentation of available components and tools here.
Use the package manager yarn to install the dependencies.
Important: Make sure you have the yarn installed globally as it is necessary for use the project's features.
Install yarn with the following command:
npm install -g yarnyarn add @nexpy/design-systemor
npm install @nexpy/design-systemInstall dependencies with the following command:
yarnyarn prepareThis command will install the husky hooks in the git repository to control preprocessors for commits and pushes, such as code formatters and Eslint, and the required automatic project settings.
If you look at the scripts inside package.json you will see several methods, among them:
yarn devA server with a fast refresh for development. Do not use for production.
yarn reinstallAsynchronously deletes all dependencies and reinstalls using yarn.
yarn commitUse the yarn commit command to start the git-cz cli. With
that we can make the commits in a standardized way.
yarn build:distCreates an optimized distribution build of the design system.
yarn type:checkRun a test using the TypeScript compiler to identify code typing failures.
yarn debugStarts the development server with debug options. V8 inspector integration allows tools such as Chrome DevTools and IDEs to debug and profile Node.js instances.
yarn prettierAuto-formats code using Prettier. This command writes possible corrections to the project files.
yarn prettier:checkChecks that all files follow the style pattern without changing them, reporting possible errors to the console.
yarn eslintLooks for code integrity errors and fixes where possible. This command writes possible corrections to the project files.
yarn eslint:checkLooks for code integrity errors in all files without changing them, reporting possible errors to the console.
yarn storybookA server with a fast refresh for components documentation development. Do not use for production.
yarn build:docsCreated a production build for storybook.