@hexure/ui 1.0.0

package/README.md

@@ -0,0 +1,36 @@
+# Getting Started
+
+InsTech UI is your basic UI Component library which makes development for the UI/UX projects easy and makes the User Interface common through out multiple web applications.
+
+1. Installation process
+   a. Install nodeJS (preferably through NVS for windows and NVM for Linux/MacOS)
+   b. To use the UI Library in your project `npx install @hexure/ui`
+   Some common Commands:
+   `npm run rollup` to run rollup and generate a dist folder
+   `npm run storybook` to run storybook server and see components on storybook.
+   `npm run test` to run all test cases.
+
+2. Usage: See `https://zeroheight.com/3b34634b9/p/57050e-itds`
+
+# Contribute
+
+    a. Pull the repo by writing `git clone https://InsuranceTechnologies@dev.azure.com/InsuranceTechnologies/Enterprise/_git/InsTech.UI.Library`
+    b. CD into the folder and type `npm i` in the terminal
+    c. VS Code is prefered but any suitable IDE can be used
+
+    Folder Structure:
+     Components are stored in the components folder. Each component has it's own folder, every component has it's own `index.ts` file that exports the component. There is another index.ts, inside the components folder that exports all components from the component directory to source. And there is another index.ts file inside the source directory which is the entry point and it exports all components for use.
+
+     Each component folder has 4 files.
+      Component Folder
+        |
+        |---> Component.tsx
+        |---> Component.test.tsx
+        |---> Component.stories.tsx
+        |---> index.ts
+
+    Considerations Regarding state:
+     Since these are visual components, the only state we define with in them is visual purpopses. We pass in the state that contains values as props.
+
+    Important Note:
+     It is  very important for you to generate a new dist folder each time you create a new component or make changes to the existing. Since we install the library through git we should have the dist folder because the project (React application) will look inside this folder for the components and styles. Since we are not creating an npm package or registry, this step is very important and the dist folder should not be added to .gitignore file.

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@hexure/ui",
+  "version": "1.0.0",
+  "description": "A library of shared UI components used within Hexure products.",
+  "scripts": {
+    "rollup": "rollup -c",
+    "test": "jest",
+    "prettier": "prettier --write src/",
+    "eslint": "eslint src/",
+    "eslint-fix": "eslint src/ --fix",
+    "test:watch": "jest --watch",
+    "storybook": "start-storybook -p 6006",
+    "build-storybook": "build-storybook"
+  },
+  "keywords": [
+    "hexure"
+  ],
+  "author": "Hexure",
+  "license": "ISC",
+  "devDependencies": {
+    "@babel/core": "^7.18.13",
+    "@babel/preset-env": "^7.18.10",
+    "@babel/preset-react": "^7.18.6",
+    "@babel/preset-typescript": "^7.18.6",
+    "@rollup/plugin-babel": "^6.0.3",
+    "@rollup/plugin-commonjs": "^24.0.1",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-terser": "^0.4.0",
+    "@rollup/plugin-typescript": "^11.0.0",
+    "@storybook/addon-actions": "^6.5.16",
+    "@storybook/addon-controls": "^6.5.16",
+    "@storybook/addon-viewport": "^6.5.16",
+    "@storybook/builder-webpack5": "^6.5.14",
+    "@storybook/manager-webpack5": "^6.5.14",
+    "@storybook/react": "^6.5.14",
+    "@storybook/testing-library": "^0.0.13",
+    "@testing-library/jest-dom": "^5.16.5",
+    "@testing-library/react": "^13.3.0",
+    "@testing-library/user-event": "^14.4.3",
+    "@types/jest": "^29.0.3",
+    "@types/numeral": "^2.0.2",
+    "@types/react": "^18.0.17",
+    "@types/styled-components": "^5.1.26",
+    "@typescript-eslint/eslint-plugin": "^5.50.0",
+    "@typescript-eslint/parser": "^5.50.0",
+    "babel-jest": "^29.0.1",
+    "babel-loader": "^8.2.5",
+    "eslint": "^8.33.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-react": "^7.32.2",
+    "identity-obj-proxy": "^3.0.0",
+    "jest": "^29.0.1",
+    "jest-environment-jsdom": "^29.0.1",
+    "jsdom": "^20.0.0",
+    "prettier": "^2.8.3",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "rollup": "^3.12.1",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "typescript": "^4.8.2"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "files": [
+    "dist"
+  ],
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "@mdi/font": "^7.0.96",
+    "@mdi/js": "^7.1.96",
+    "@mdi/react": "^1.6.1",
+    "@storybook/client-api": "^6.5.14",
+    "lodash": "github:lodash/lodash",
+    "moment": "^2.29.4",
+    "numeral": "^2.0.6",
+    "styled-components": "^5.3.6"
+  },
+  "peerDependencies": {
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://InsuranceTechnologies@dev.azure.com/InsuranceTechnologies/Enterprise/_git/InsTech.UI.Library"
+  }
+}