Updated Read me

This commit is contained in:
2023-06-18 19:52:28 +05:30
parent 21354bf1dd
commit 5ef53b245a
6 changed files with 168 additions and 29 deletions

1
.gitignore vendored
View File

@@ -25,6 +25,7 @@ coverage
# Production
build
dist
# Miscellaneous
*.local

View File

@@ -1,8 +1,18 @@
# Armory React Components
[![NPM version][npm-image]][npm-url]
[![Build][github-build]][github-build-url]
![npm-typescript]
[![License][github-license]][github-license-url]
# Armco's Suite of React component library
### Built on tech stack: React, TS, Dart Sass, Redux Tookkit, react-redux, react browser routing, TS based plop generator
### Published at npm and publicly available
### FOR SOMEONE INTENDING TO USE THIS PACKAGE: This is a placeholder package currently in development, contains dummy components yet to be implemented
### PLACEHOLDER PACKAGE, IN DEV
### Version with implementations: 1.0.0
###### IN BETA

93
package-lock.json generated
View File

@@ -1,15 +1,15 @@
{
"name": "@armco/armory-react-components",
"version": "0.1.0",
"version": "0.0.8",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "@armco/armory-react-components",
"version": "0.1.0",
"version": "0.0.8",
"license": "ISC",
"dependencies": {
"@armco/armory-react-components": "^0.1.0",
"@armco/armory-react-components": "^0.0.8",
"@popperjs/core": "^2.11.8",
"@reduxjs/toolkit": "^1.8.1",
"bootstrap": "^5.3.0",
@@ -63,10 +63,46 @@
}
},
"node_modules/@armco/armory-react-components": {
"version": "0.1.0",
"resolved": "https://registry.npmjs.org/@armco/armory-react-components/-/armory-react-components-0.1.0.tgz",
"integrity": "sha512-93JxA0dUokky7C31OEou9th6Gw9uDjAu7ME3NEhzplRzZYF2zmR/Bk2Eu5pdjp/DvqSYCne2ihwmri4fWHWl9Q==",
"version": "0.0.8",
"resolved": "https://registry.npmjs.org/@armco/armory-react-components/-/armory-react-components-0.0.8.tgz",
"integrity": "sha512-AdXD5Q5Jp3IPuXzc4NA50JbCmAObtfBsjgEiFKnGxAFBVwO/Myk+rAF3VTYptyyz63/KufLUWxIabYiW4X3Fjg==",
"dependencies": {
"@armco/armory-react-components": "^0.0.3",
"@popperjs/core": "^2.11.8",
"@reduxjs/toolkit": "^1.8.1",
"bootstrap": "^5.3.0",
"react": "^18.2.0",
"react-app-polyfill": "^3.0.0",
"react-dev-utils": "^12.0.1",
"react-dom": "^18.2.0",
"react-redux": "^8.0.1",
"react-router-dom": "^6.13.0"
}
},
"node_modules/@armco/armory-react-components/node_modules/@armco/armory-react-components": {
"version": "0.0.3",
"resolved": "https://registry.npmjs.org/@armco/armory-react-components/-/armory-react-components-0.0.3.tgz",
"integrity": "sha512-+lXMYiY9ANtS+uzIZQnAU9OBv+4M/Y4Jn3INq/zDJ9RRqR+bILoyrLv9treifgPbxEME7HgkLlJQJeE1DG5xGQ==",
"dependencies": {
"@armco/armory-react-components": "^0.1.3",
"@popperjs/core": "^2.11.8",
"@reduxjs/toolkit": "^1.8.1",
"bootstrap": "^5.3.0",
"react": "^18.2.0",
"react-app-polyfill": "^3.0.0",
"react-dev-utils": "^12.0.1",
"react-dom": "^18.2.0",
"react-redux": "^8.0.1",
"react-router-dom": "^6.13.0"
}
},
"node_modules/@armco/armory-react-components/node_modules/@armco/armory-react-components/node_modules/@armco/armory-react-components": {
"version": "0.1.3",
"resolved": "https://registry.npmjs.org/@armco/armory-react-components/-/armory-react-components-0.1.3.tgz",
"integrity": "sha512-EwwqgHmdtEINxIzfjTg1MEKdvwEAEklviVXI4rO0EsoooXsXJEOfe4914cpTBCQFhk2/rGoggIIyTRpV75GCqg==",
"deprecated": "this version has been deprecated",
"dependencies": {
"@armco/armory-react-components": "^0.1.0",
"@popperjs/core": "^2.11.8",
"@reduxjs/toolkit": "^1.8.1",
"bootstrap": "^5.3.0",
@@ -11363,10 +11399,11 @@
}
},
"@armco/armory-react-components": {
"version": "0.1.0",
"resolved": "https://registry.npmjs.org/@armco/armory-react-components/-/armory-react-components-0.1.0.tgz",
"integrity": "sha512-93JxA0dUokky7C31OEou9th6Gw9uDjAu7ME3NEhzplRzZYF2zmR/Bk2Eu5pdjp/DvqSYCne2ihwmri4fWHWl9Q==",
"version": "0.0.8",
"resolved": "https://registry.npmjs.org/@armco/armory-react-components/-/armory-react-components-0.0.8.tgz",
"integrity": "sha512-AdXD5Q5Jp3IPuXzc4NA50JbCmAObtfBsjgEiFKnGxAFBVwO/Myk+rAF3VTYptyyz63/KufLUWxIabYiW4X3Fjg==",
"requires": {
"@armco/armory-react-components": "^0.0.3",
"@popperjs/core": "^2.11.8",
"@reduxjs/toolkit": "^1.8.1",
"bootstrap": "^5.3.0",
@@ -11376,6 +11413,44 @@
"react-dom": "^18.2.0",
"react-redux": "^8.0.1",
"react-router-dom": "^6.13.0"
},
"dependencies": {
"@armco/armory-react-components": {
"version": "0.0.3",
"resolved": "https://registry.npmjs.org/@armco/armory-react-components/-/armory-react-components-0.0.3.tgz",
"integrity": "sha512-+lXMYiY9ANtS+uzIZQnAU9OBv+4M/Y4Jn3INq/zDJ9RRqR+bILoyrLv9treifgPbxEME7HgkLlJQJeE1DG5xGQ==",
"requires": {
"@armco/armory-react-components": "^0.1.3",
"@popperjs/core": "^2.11.8",
"@reduxjs/toolkit": "^1.8.1",
"bootstrap": "^5.3.0",
"react": "^18.2.0",
"react-app-polyfill": "^3.0.0",
"react-dev-utils": "^12.0.1",
"react-dom": "^18.2.0",
"react-redux": "^8.0.1",
"react-router-dom": "^6.13.0"
},
"dependencies": {
"@armco/armory-react-components": {
"version": "0.1.3",
"resolved": "https://registry.npmjs.org/@armco/armory-react-components/-/armory-react-components-0.1.3.tgz",
"integrity": "sha512-EwwqgHmdtEINxIzfjTg1MEKdvwEAEklviVXI4rO0EsoooXsXJEOfe4914cpTBCQFhk2/rGoggIIyTRpV75GCqg==",
"requires": {
"@armco/armory-react-components": "^0.1.0",
"@popperjs/core": "^2.11.8",
"@reduxjs/toolkit": "^1.8.1",
"bootstrap": "^5.3.0",
"react": "^18.2.0",
"react-app-polyfill": "^3.0.0",
"react-dev-utils": "^12.0.1",
"react-dom": "^18.2.0",
"react-redux": "^8.0.1",
"react-router-dom": "^6.13.0"
}
}
}
}
}
},
"@babel/code-frame": {

View File

@@ -1,13 +1,16 @@
{
"name": "@armco/armory-react-components",
"description": "React Component Library for Armco's stack of products and services",
"version": "0.1.0",
"version": "0.0.8",
"type": "module",
"author": "Armco",
"author": "Armco (@restruct-corporate-advantage)",
"scripts": {
"dev": "vite",
"start": "vite",
"build": "tsc && vite build",
"build": "tsc --project ./tsconfig-vite.json && vite build",
"build:publish": "npm run build:esm && npm run build:cjs",
"build:esm": "tsc",
"build:cjs": "tsc --module commonjs --outDir dist/cjs",
"generate": "plop",
"atom": "plop atom",
"molecule": "plop molecule",
@@ -17,10 +20,13 @@
"test": "vitest",
"format": "prettier --write .",
"lint": "eslint .",
"type-check": "tsc"
"type-check": "tsc",
"publish:dry": "npm publish --dry-run",
"publish:public": "npm publish --access public",
"prepublishOnly": "npm run build:publish && npm --no-git-tag-version version patch"
},
"dependencies": {
"@armco/armory-react-components": "^0.1.0",
"@armco/armory-react-components": "^0.0.8",
"@popperjs/core": "^2.11.8",
"@reduxjs/toolkit": "^1.8.1",
"bootstrap": "^5.3.0",
@@ -73,14 +79,24 @@
"url": "git+https://github.com/ReStruct-Corporate-Advantage/armory-react-components.git"
},
"keywords": [
"react",
"vite",
"reduxToolkit",
"sass",
"components",
"atomic",
"building-blocks",
"foundation"
],
"files": [
"dist"
],
"license": "ISC",
"bugs": {
"url": "https://github.com/ReStruct-Corporate-Advantage/armory-react-components/issues"
},
"homepage": "https://github.com/ReStruct-Corporate-Advantage/armory-react-components#readme"
"homepage": "https://github.com/ReStruct-Corporate-Advantage/armory-react-components#readme",
"peerDependencies": {
"react": ">=16"
}
}

27
tsconfig-vite.json Normal file
View File

@@ -0,0 +1,27 @@
{
"compilerOptions": {
"target": "es5",
"lib": [
"dom",
"dom.iterable",
"esnext"
],
"allowJs": true,
"downlevelIteration": true,
"skipLibCheck": true,
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"strict": true,
"forceConsistentCasingInFileNames": true,
"noFallthroughCasesInSwitch": true,
"module": "esnext",
"moduleResolution": "node",
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"jsx": "react-jsx",
},
"include": [
"src"
]
}

View File

@@ -1,27 +1,37 @@
{
"compilerOptions": {
"target": "es5",
"allowJs": true,
"allowSyntheticDefaultImports": true,
"declaration": true,
"downlevelIteration": true,
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
"importHelpers": true,
"isolatedModules": true,
"jsx": "react-jsx",
"lib": [
"dom",
"dom.iterable",
"esnext"
],
"allowJs": true,
"downlevelIteration": true,
"skipLibCheck": true,
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"strict": true,
"forceConsistentCasingInFileNames": true,
"noFallthroughCasesInSwitch": true,
"module": "esnext",
"moduleResolution": "node",
"noFallthroughCasesInSwitch": true,
"noImplicitReturns": true,
"outDir": "./dist/esm",
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"jsx": "react-jsx",
"rootDir": "./src",
"skipLibCheck": true,
"sourceMap": true,
"strict": true,
"target": "es5",
},
"include": [
"src"
]
],
"exclude": [
"build",
"plop-templates",
"node_modules"
],
}