@bikdotai/bik-component-library 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Boilertown
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,100 @@
+<h1 align="center">♨️ React UI Boilerplate</h1>
+
+<div align="center">
+  <p>
+    A React boilerplate with opinionated setup to help you quickly create your own React UI library.
+  </p>
+  <img src="https://img.shields.io/github/license/boilertown/react-ui-boilerplate?style=flat-square" alt="MIT license" >
+</div>
+
+## The Setup
+
+- [React v18][react-url]
+- [TypeScript][typescript-url]
+- UI development with [Storybook][storybook-url]
+- Unit test with [Testing-library][testing-library-url]
+- Linting with [Eslint][eslint-url] and code formatting with [Prettier][prettier-url]
+- Conventional commit messages with [Commitlint][commitlint-url]
+- Build the library with [Rollup][rollup-url]
+- Automated release with [changesets][changesets-url]
+
+## Get Started
+
+- Use [Boilertown](https://github.com/boilertown/create-boilertown) CLI.
+
+  ```sh
+  # npm
+  npm create boilertown -- -b react-ui-boilerplate
+
+  # yarn
+  yarn create boilertown -b react-ui-boilerplate
+
+  # pnpm
+  pnpm create boilertown -b react-ui-boilerplate
+
+  # bun
+  bun create boilertown/react-ui-boilerplate [library-name]
+  ```
+
+- Click the green "Use this template" button to generate a new repository with the same structure and files.
+
+  <img src="https://docs.github.com/assets/cb-36544/images/help/repository/use-this-template-button.png" alt="Use this template button" width="500">
+
+  [Ref: Github Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
+
+## Development
+
+- Build the library:
+
+  ```sh
+  pnpm build
+  ```
+
+- Run storybook:
+
+  ```sh
+  pnpm storybook
+  ```
+
+- Unit test component with:
+
+  ```sh
+  pnpm test
+  ```
+
+- Create changeset:
+
+  ```sh
+  pnpm changeset
+  ```
+
+## Release & Publish package
+
+This boilerplate uses [changesets][changesets-url] to automatically generate `CHANGELOG`, create releases and publish to NPM registry via GitHub Actions. You can see action details at [release.yml](/.github/workflows//release.yml).
+
+To automating publish your library, follow these steps:
+
+- Create a `NPM_TOKEN`. [See this article for more details](https://docs.npmjs.com/creating-and-viewing-access-tokens). Make sure the type of access token is **Automation**.
+
+- [Follow this instruction](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) to add the created token to your GitHub Actions secrets. Name of the secret is `NPM_TOKEN`.
+
+- Install [changeset bot](https://github.com/apps/changeset-bot).
+
+- [Adding changeset and commit](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md#i-am-in-a-single-package-repository).
+
+**P/S**: Remember to check the `Allow GitHub Actions to create and approve pull requests` in your repo Settings > Actions > General & scroll to Workflow permissions.
+
+## Contributing
+
+**react-ui-boilerplate** ❤️ your contributions. If you have any ideas, suggestions, fixes, feel free to contribute.
+
+[boilertown-url]: https://github.com/boilertown
+[react-url]: https://beta.reactjs.org
+[typescript-url]: https://www.typescriptlang.org
+[storybook-url]: https://storybook.js.org
+[eslint-url]: https://eslint.org
+[commitlint-url]: https://github.com/conventional-changelog/commitlint
+[prettier-url]: https://prettier.io
+[testing-library-url]: https://testing-library.com
+[rollup-url]: https://rollupjs.org
+[changesets-url]: https://github.com/changesets/changesets

package/package.json

@@ -0,0 +1,131 @@
+{
+	"name": "@bikdotai/bik-component-library",
+	"version": "0.0.0",
+	"description": "Bik Component Library",
+	"repository": {
+		"type": "git",
+		"url": "https://gitlab.com/bikayi-org/bikayi-server/bik-component-library"
+	},
+	"sideEffects": false,
+	"exports": {
+		"import": "./dist/esm/index.js",
+		"require": "./dist/cjs/index.js"
+	},
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"types": "dist/esm/index.d.ts",
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "NODE_ENV=production rollup -c && npm pack && mv bik-component-library-0.0.0.tgz ../bikayi-web-ui/merchantAdminReact/",
+		"build:storybook": "build-storybook",
+		"lint": "eslint . --ext .ts,.tsx,.js,.jsx",
+		"prepare": "husky install",
+		"storybook": "start-storybook -p 6006 --quiet",
+		"test": "NODE_ENV=test jest",
+		"test:coverage": "NODE_ENV=test jest --coverage",
+		"test:watch": "NODE_ENV=test jest --watch",
+		"changeset": "changeset",
+		"release": "changeset publish"
+	},
+	"lint-staged": {
+		"*.{js,jsx,ts,tsx}": [
+			"eslint --fix",
+			"prettier --write"
+		],
+		"*.{md,mdx,yml,json}": [
+			"prettier --write"
+		]
+	},
+	"browserslist": [
+		"> 1%",
+		"not dead",
+		"not edge <= 18",
+		"not ie 11",
+		"not op_mini all"
+	],
+	"dependencies": {
+		"@babel/runtime": "^7.20.7"
+	},
+	"devDependencies": {
+		"@babel/core": "^7.20.12",
+		"@babel/plugin-transform-runtime": "^7.19.6",
+		"@babel/preset-env": "^7.20.2",
+		"@babel/preset-react": "^7.18.6",
+		"@changesets/cli": "^2.26.0",
+		"@commitlint/cli": "^17.4.1",
+		"@commitlint/config-conventional": "^17.4.0",
+		"@emotion/babel-plugin": "^11.10.5",
+		"@emotion/react": "^11.10.5",
+		"@emotion/styled": "^11.10.5",
+		"@mdx-js/react": "^1.6.22",
+		"@rollup/plugin-babel": "^6.0.3",
+		"@rollup/plugin-commonjs": "^24.0.0",
+		"@rollup/plugin-node-resolve": "^15.0.1",
+		"@rollup/plugin-terser": "^0.3.0",
+		"@storybook/addon-a11y": "^6.5.15",
+		"@storybook/addon-actions": "^6.5.15",
+		"@storybook/addon-essentials": "^6.5.15",
+		"@storybook/addon-interactions": "^6.5.15",
+		"@storybook/addon-links": "^6.5.15",
+		"@storybook/builder-webpack5": "^6.5.15",
+		"@storybook/manager-webpack5": "^6.5.15",
+		"@storybook/react": "^6.5.15",
+		"@storybook/testing-library": "^0.0.13",
+		"@svgr/rollup": "^7.0.0",
+		"@svgr/webpack": "^7.0.0",
+		"@testing-library/jest-dom": "^5.16.5",
+		"@testing-library/react": "^13.4.0",
+		"@testing-library/user-event": "^14.4.3",
+		"@trivago/prettier-plugin-sort-imports": "^4.0.0",
+		"@types/jest": "^29.2.5",
+		"@types/node": "^18.11.18",
+		"@types/react": "^18.0.26",
+		"@types/react-dom": "^18.0.10",
+		"@types/styled-components": "^5.1.26",
+		"@types/testing-library__jest-dom": "^5.14.5",
+		"@typescript-eslint/eslint-plugin": "^5.48.1",
+		"@typescript-eslint/parser": "^5.48.1",
+		"@zerollup/ts-transform-paths": "^1.7.18",
+		"babel-loader": "^9.1.2",
+		"eslint": "8.31.0",
+		"eslint-config-prettier": "^8.6.0",
+		"eslint-plugin-jsx-a11y": "^6.7.1",
+		"eslint-plugin-prettier": "^4.2.1",
+		"eslint-plugin-react": "^7.32.0",
+		"eslint-plugin-react-hooks": "^4.6.0",
+		"eslint-plugin-testing-library": "^5.9.1",
+		"husky": "^8.0.3",
+		"jest": "^29.3.1",
+		"jest-environment-jsdom": "^29.3.1",
+		"jest-transform-stub": "^2.0.0",
+		"lint-staged": "^13.1.0",
+		"prettier": "^2.8.2",
+		"react": "^18.2.0",
+		"react-dom": "^18.2.0",
+		"rollup": "^2.79.1",
+		"rollup-plugin-copy": "^3.4.0",
+		"rollup-plugin-delete": "^2.0.0",
+		"rollup-plugin-peer-deps-external": "^2.2.4",
+		"rollup-plugin-typescript2": "^0.34.1",
+		"styled-components": "^5.3.3",
+		"ts-jest": "^29.0.4",
+		"tslib": "^2.4.1",
+		"ttypescript": "^1.5.15",
+		"typescript": "^4.9.4",
+		"typescript-transform-paths": "^3.4.6",
+		"webpack": "^5.75.0",
+		"webpack-cli": "^5.0.1"
+	},
+	"peerDependencies": {
+		"@emotion/react": "^11.0.0",
+		"@emotion/styled": "^11.0.0",
+		"react": "^16.8.0 || ^17 || ^18",
+		"react-dom": "^16.8.0 || ^17 || ^18",
+		"styled-components": "^5.3.3"
+	},
+	"engines": {
+		"node": ">=16"
+	}
+}