{"_id":"@boilertown/react-ui-boilerplate","name":"@boilertown/react-ui-boilerplate","dist-tags":{"latest":"0.0.0"},"versions":{"0.0.0":{"name":"@boilertown/react-ui-boilerplate","version":"0.0.0","description":"React UI library boilerplate","repository":{"type":"git","url":"git+https://github.com/boilertown/react-ui-boilerplate.git"},"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","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","@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","@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-delete":"^2.0.0","rollup-plugin-peer-deps-external":"^2.2.4","rollup-plugin-terser":"^7.0.2","rollup-plugin-typescript2":"^0.34.1","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"},"engines":{"node":">=16"},"scripts":{"build":"NODE_ENV=production rollup -c","build:storybook":"build-storybook","lint":"eslint . --ext .ts,.tsx,.js,.jsx","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"},"bugs":{"url":"https://github.com/boilertown/react-ui-boilerplate/issues"},"homepage":"https://github.com/boilertown/react-ui-boilerplate#readme","_id":"@boilertown/react-ui-boilerplate@0.0.0","_integrity":"sha512-w5je26wsGZe4ktVPekIlKeAoY1RfWxJefUKbcBIzHgW64t0xYeE/A/fQhdQpkSgWlht9Y3Qnt6LrQUDo3I50vA==","_resolved":"/tmp/6b89a821bcf14fb5b689d7f9cdf85ea8/boilertown-react-ui-boilerplate-0.0.0.tgz","_from":"file:boilertown-react-ui-boilerplate-0.0.0.tgz","_nodeVersion":"16.19.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-w5je26wsGZe4ktVPekIlKeAoY1RfWxJefUKbcBIzHgW64t0xYeE/A/fQhdQpkSgWlht9Y3Qnt6LrQUDo3I50vA==","shasum":"d3998d83be406b112be9ad8ededcc06c7c3acf26","tarball":"https://registry.npmjs.org/@boilertown/react-ui-boilerplate/-/react-ui-boilerplate-0.0.0.tgz","fileCount":53,"unpackedSize":45911,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEHfijBoAjiv1Zdf4VQOoEDBdHHa4TiTg7ozDASlJWDeAiEAx03s2SFfyPj+qbzAfo05TiNB/WvFbHOABOdvxGnwcBw="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjv7BiACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpUTw//Y/CUZ4pE/Z0OFh6vWQn5X6MMuqJXjl3gXDyUNUhJcNqwAgFz\r\nbOC/mAdBlvSVvW0zCnpMsVbi+FtfHKB/Mk2yOd8GdkG7wdDbCra5lko1yif+\r\n26ZDh8tFzlfep4qHA0fMFt7EJN1fzlu6tnfD4NMzo3eRhfKz+WwHT97v+tr8\r\notxuwRZ3b41ze8QxdjeKig7qWdCyYhoL6PAptYqm/wuf2moq+NW35tgbwa7K\r\nLoOr/stfM9DYW1qhunOQheeZFXoePoxJHfuDQsjaXubQHlPUOvNpeRABs0Q9\r\nlI5e6vmGrQ1joGA3eCF/5Mb6S3bl9eMmzAbRmWZLWpKsEX5xbGVqrDuTGt1b\r\nCHdDA6+Xt6JhmIivNvaUSbV0uH6iAxmOmmCiiT0QOoI9DpUMxO4oF1//0p67\r\n2waXivFq9RPCYoeOezvxjmDCIQN6Nu7VurUATwJKDKLq1P/yPS5orTDeo/DA\r\nM2W+AqShHwuznZMoWCXfvFsPg7oQNZKJOOWEb8GEfI8sg3Z4TsDbKt/vq9jr\r\n3io8IkNFkk/OrwW6rnmP7y4UzKniODzcICDQiBLX+Fbz5FgClxQpZBDFEsda\r\n4y6CxpS1TmQsPJ21C/kkln9np7pHQiQjStIXGf4nV/fOTnpL2P+j92ZaEE7t\r\nhcwsj7/9KJUuapVtDvOCTLkEuKpPNeIVh1U=\r\n=9nHk\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"phammikun","email":"mikun1993@gmail.com"},"directories":{},"maintainers":[{"name":"phammikun","email":"mikun1993@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/react-ui-boilerplate_0.0.0_1673506914262_0.6332270067493402"},"_hasShrinkwrap":false}},"time":{"created":"2023-01-12T07:01:54.190Z","0.0.0":"2023-01-12T07:01:54.446Z","modified":"2023-01-12T07:01:54.630Z"},"maintainers":[{"name":"phammikun","email":"mikun1993@gmail.com"}],"description":"React UI library boilerplate","homepage":"https://github.com/boilertown/react-ui-boilerplate#readme","repository":{"type":"git","url":"git+https://github.com/boilertown/react-ui-boilerplate.git"},"bugs":{"url":"https://github.com/boilertown/react-ui-boilerplate/issues"},"readme":"

♨️ React UI Boilerplate

\n\n
\n

\n A React boilerplate with opinionated setup to help you quickly create your own React UI library.\n

\n \"MIT\n
\n\n## The Setup\n\n- [React v18][react-url]\n- [TypeScript][typescript-url]\n- UI development with [Storybook][storybook-url]\n- Unit test with [Testing-library][testing-library-url]\n- Linting with [Eslint][eslint-url] and code formatting with [Prettier][prettier-url]\n- Conventional commit messages with [Commitlint][commitlint-url]\n- Build the library with [Rollup][rollup-url]\n- Automated release with [changesets][changesets-url]\n\n## Get Started\n\n- Use [Boilertown](https://github.com/boilertown/create-boilertown) CLI.\n\n ```sh\n # npm\n npm create boilertown -- -b react-ui-boilerplate\n\n # yarn\n yarn create boilertown -b react-ui-boilerplate\n\n # pnpm\n pnpm create boilertown -b react-ui-boilerplate\n\n # bun\n bun create boilertown/react-ui-boilerplate [library-name]\n ```\n\n- Click the green \"Use this template\" button to generate a new repository with the same structure and files.\n\n \"Use\n\n [Ref: Github Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)\n\n## Development\n\n- Build the library:\n\n ```sh\n pnpm build\n ```\n\n- Run storybook:\n\n ```sh\n pnpm storybook\n ```\n\n- Unit test component with:\n\n ```sh\n pnpm test\n ```\n\n- Create changeset:\n\n ```sh\n pnpm changeset\n ```\n\n## Release & Publish package\n\nThis 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).\n\nTo automating publish your library, follow these steps:\n\n- 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**.\n\n- [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`.\n\n- Install [changeset bot](https://github.com/apps/changeset-bot).\n\n- [Adding changeset and commit](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md#i-am-in-a-single-package-repository).\n\n**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.\n\n## Contributing\n\n**react-ui-boilerplate** ❤️ your contributions. If you have any ideas, suggestions, fixes, feel free to contribute.\n\n[boilertown-url]: https://github.com/boilertown\n[react-url]: https://beta.reactjs.org\n[typescript-url]: https://www.typescriptlang.org\n[storybook-url]: https://storybook.js.org\n[eslint-url]: https://eslint.org\n[commitlint-url]: https://github.com/conventional-changelog/commitlint\n[prettier-url]: https://prettier.io\n[testing-library-url]: https://testing-library.com\n[rollup-url]: https://rollupjs.org\n[changesets-url]: https://github.com/changesets/changesets\n","readmeFilename":"README.md"}