{"id":13652312,"url":"https://github.com/Sivakumar00/react-typescript-npm-boilerplate","last_synced_at":"2025-04-23T03:30:40.350Z","repository":{"id":101641366,"uuid":"412387114","full_name":"Sivakumar00/react-typescript-npm-boilerplate","owner":"Sivakumar00","description":"A react typescript npm component boilerplate","archived":false,"fork":false,"pushed_at":"2021-10-05T09:16:44.000Z","size":17,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-01-24T07:05:46.517Z","etag":null,"topics":["boilerplate-template","npm","react","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Sivakumar00.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-10-01T08:25:01.000Z","updated_at":"2024-01-24T07:05:46.518Z","dependencies_parsed_at":"2023-06-07T03:15:39.212Z","dependency_job_id":null,"html_url":"https://github.com/Sivakumar00/react-typescript-npm-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sivakumar00%2Freact-typescript-npm-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sivakumar00%2Freact-typescript-npm-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sivakumar00%2Freact-typescript-npm-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sivakumar00%2Freact-typescript-npm-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sivakumar00","download_url":"https://codeload.github.com/Sivakumar00/react-typescript-npm-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250365245,"owners_count":21418654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate-template","npm","react","typescript"],"created_at":"2024-08-02T02:00:58.225Z","updated_at":"2025-04-23T03:30:39.739Z","avatar_url":"https://github.com/Sivakumar00.png","language":"TypeScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003chtml\u003e\n\u003chead\u003e\n \u003c!-- Place this tag in your head or just before your close body tag. --\u003e\n \u003c/head\u003e\n \u003cbody\u003e\n\u003ch1 id=\"react-typescript-npm-boilerplate\"\u003ereact-typescript-npm-boilerplate\u003c/h1\u003e\n\u003cp\u003e\u003cimg src=\"https://user-images.githubusercontent.com/32809581/135594096-a2378f7e-1a16-45a2-845c-824510554845.png\" alt=\"react-typescript-npm-boilerplate\"\u003e\u003c/p\u003e\n\u003ch3 id=\"start-your-next-react-typescript-npm-package-project-in-seconds\"\u003eStart your next react typescript npm package project in seconds\u003c/h3\u003e\n\u003cp\u003eA highly scalable, focus on performance and best practices\u003c/p\u003e\n\u003cp\u003e\u003ca href=\"https://open.vscode.dev/Sivakumar00/react-typescript-npm-boilerplate\"\u003e\u003cimg src=\"https://open.vscode.dev/badges/open-in-vscode.svg\" alt=\"Open in Visual Studio Code\"\u003e\u003c/a\u003e\u003c/p\u003e\n\u003ch5 id=\"browse-in-github1s-https-github1s-com-sivakumar00-react-typescript-npm-boilerplate-\"\u003eBrowse in \u003ca href=\"https://github1s.com/Sivakumar00/react-typescript-npm-boilerplate\"\u003eGithub1s\u003c/a\u003e\u003c/h5\u003e\n\u003chr\u003e\n\u003ch3 id=\"built-with\"\u003eBuilt with\u003c/h3\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href=\"https://reactjs.org/\"\u003eReactJS v17.0.2\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"https://www.typescriptlang.org/\"\u003eTypeScript\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"https://eslint.org/\"\u003eEslint\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"https://prettier.io/\"\u003ePrettier\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"https://storybook.js.org/\"\u003eStory Book\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"https://github.com/typicode/husky\"\u003eHusky-Git hooks\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"https://jestjs.io/\"\u003eJest\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"https://rollupjs.org/\"\u003eRollup.js\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"https://github.com/marak/Faker.js/\"\u003eFaker.js\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eand some ✨Magic ✨\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id=\"usage\"\u003eUsage\u003c/h2\u003e\n\u003cp\u003eThis boilerplate requires \u003ca href=\"https://nodejs.org/\"\u003eNode.js\u003c/a\u003e v10+ to run.\u003c/p\u003e\n\u003cp\u003eInstall the dependencies and devDependencies and start the storybook.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class=\"lang-sh\"\u003egit \u003cspan class=\"hljs-built_in\"\u003eclone\u003c/span\u003e \u0026lt;\u003cspan class=\"hljs-built_in\"\u003eclone\u003c/span\u003e url\u0026gt;\n\u003cspan class=\"hljs-built_in\"\u003ecd\u003c/span\u003e react-typescript-npm-boilerplate\nnpm i\nnpm run storybook\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor production build\u003c/p\u003e\n\u003cpre\u003e\u003ccode class=\"lang-sh\"\u003enpm \u003cspan class=\"hljs-keyword\"\u003erun\u003c/span\u003e\u003cspan class=\"bash\"\u003e build\u003c/span\u003e\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor unit testing\u003c/p\u003e\n\u003cpre\u003e\u003ccode class=\"lang-sh\"\u003enpm \u003cspan class=\"hljs-keyword\"\u003erun\u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-built_in\"\u003etest\u003c/span\u003e\u003c/span\u003e\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor unit test \u0026amp; generate JUnit report\u003c/p\u003e\n\u003cpre\u003e\u003ccode class=\"lang-sh\"\u003enpm \u003cspan class=\"hljs-keyword\"\u003erun\u003c/span\u003e\u003cspan class=\"bash\"\u003e \u003cspan class=\"hljs-built_in\"\u003etest\u003c/span\u003e:junit\u003c/span\u003e\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor lint check and fix\u003c/p\u003e\n\u003cpre\u003e\u003ccode class=\"lang-sh\"\u003enpm \u003cspan class=\"hljs-keyword\"\u003erun\u003c/span\u003e\u003cspan class=\"bash\"\u003e lint\n\u003c/span\u003enpm \u003cspan class=\"hljs-keyword\"\u003erun\u003c/span\u003e\u003cspan class=\"bash\"\u003e lint:fix\u003c/span\u003e\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor build storybook\u003c/p\u003e\n\u003cpre\u003e\u003ccode class=\"lang-sh\"\u003enpm \u003cspan class=\"hljs-keyword\"\u003erun\u003c/span\u003e\u003cspan class=\"bash\"\u003e build-storybook\u003c/span\u003e\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch4 id=\"how-git-commit-works-\"\u003eHow git commit works?\u003c/h4\u003e\n\u003cp\u003eSince we are using \u003ca href=\"https://github.com/conventional-changelog/commitlint\"\u003eConventional-commits\u003c/a\u003e. There should be subject mentioned in the below list.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class=\"lang-sh\"\u003egit commit -m \"\u003cspan class=\"hljs-tag\"\u003e\u0026lt;\u003cspan class=\"hljs-name\"\u003esubject\u003c/span\u003e\u0026gt;\u003c/span\u003e: \u003cspan class=\"hljs-tag\"\u003e\u0026lt;\u003cspan class=\"hljs-name\"\u003emessage\u003c/span\u003e\u0026gt;\u003c/span\u003e\"\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor example:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class=\"lang-sh\"\u003e\u003cspan class=\"hljs-attribute\"\u003egit\u003c/span\u003e commit -m \u003cspan class=\"hljs-string\"\u003e\"chore: commit message here\"\u003c/span\u003e\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch5 id=\"list-of-commit-subjects-\"\u003eList of commit subjects:\u003c/h5\u003e\n\u003cul\u003e\n\u003cli\u003ebuild\u003c/li\u003e\n\u003cli\u003eci\u003c/li\u003e\n\u003cli\u003echore\u003c/li\u003e\n\u003cli\u003edocs\u003c/li\u003e\n\u003cli\u003efeat\u003c/li\u003e\n\u003cli\u003efix\u003c/li\u003e\n\u003cli\u003eperf\u003c/li\u003e\n\u003cli\u003erefactor\u003c/li\u003e\n\u003cli\u003erevert\u003c/li\u003e\n\u003cli\u003estyle\u003c/li\u003e\n\u003cli\u003etest\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch5 id=\"pre-commit-checks\"\u003ePre-commit checks\u003c/h5\u003e\n\u003cp\u003eEverytime you commit the code, there will be following checks:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eEslint check\u003c/li\u003e\n\u003cli\u003ePrettier format check\u003c/li\u003e\n\u003cli\u003eUnit test check\u003c/li\u003e\n\u003cli\u003eBuild success check\u003c/li\u003e\n\u003c/ul\u003e\n\u003cblockquote\u003e\n\u003cp\u003eYou can add/remove the checks in .husky/pre-commit file\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003chr\u003e\n\u003cp\u003eWant to contribute? Great! \u003c/p\u003e\n\u003ch2 id=\"license\"\u003eLicense\u003c/h2\u003e\n\u003cp\u003eMIT (Free software)\u003c/p\u003e\n\n \u003c/body\u003e\n \u003c/html\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSivakumar00%2Freact-typescript-npm-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSivakumar00%2Freact-typescript-npm-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSivakumar00%2Freact-typescript-npm-boilerplate/lists"}