@smart-factor/gem-ui-components 0.0.1

package/README.md

@@ -0,0 +1,29 @@
+# Gem UI Components
+
+## Prerequisites
+
+Ensure you have `yarn` installed. If not, you can install it by running:
+
+`npm install --global yarn`
+
+## Install all dependencies
+
+Run `yarn` to install all project dependencies.
+
+## Storybook
+
+Run `yarn storybook` for components library via Storybook. Navigate to http://localhost:6006/
+
+## Build
+
+Run `yarn build` to build the project. The build artifacts will be stored in the dist/ directory.
+
+## Linting and Formatting
+
+Run `yarn lint` to get a report of all lint issues in the project.
+Run `yarn lint:fix` to automatically fix all lint issues that can be resolved, and get a report of any remaining issues.
+Run `yarn format` to format the entire project according to Prettier and ESLint rules.
+
+## Running tests
+
+Run `yarn test:ui` to execute all tests and provide a report of the results via vitest.