{"id":13559962,"url":"https://github.com/R35007/vite-react-typescript","last_synced_at":"2025-04-03T15:31:17.578Z","repository":{"id":161609991,"uuid":"636280905","full_name":"R35007/vite-react-typescript","owner":"R35007","description":"⚛️ A simple  vite react typescript starter template with husky, conventional commit, eslint, stylelint, prettier, sass, tailwindcss, material ui, tanstack routing, redux and saga, vitest and cypress","archived":false,"fork":false,"pushed_at":"2023-07-30T10:48:34.000Z","size":406,"stargazers_count":19,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-04T11:38:46.953Z","etag":null,"topics":["conventional-commits","cypress","eslint","material-ui","react","redux","saga","sass","stylelint","tailwindcss","tanstack-router","vite","vite-react-typescript","vite-react-typescript-template","vite-template-react","vitest","workflow"],"latest_commit_sha":null,"homepage":"https://codesandbox.io/p/github/R35007/vite-react-typescript/main?file=/src/main.tsx","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/R35007.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-04T13:52:09.000Z","updated_at":"2024-10-11T21:58:10.000Z","dependencies_parsed_at":"2024-01-14T02:52:33.408Z","dependency_job_id":"dbd9eb6d-d262-45c3-8707-d8d155fef420","html_url":"https://github.com/R35007/vite-react-typescript","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/R35007%2Fvite-react-typescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/R35007%2Fvite-react-typescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/R35007%2Fvite-react-typescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/R35007%2Fvite-react-typescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/R35007","download_url":"https://codeload.github.com/R35007/vite-react-typescript/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247027885,"owners_count":20871611,"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":["conventional-commits","cypress","eslint","material-ui","react","redux","saga","sass","stylelint","tailwindcss","tanstack-router","vite","vite-react-typescript","vite-react-typescript-template","vite-template-react","vitest","workflow"],"created_at":"2024-08-01T13:00:35.534Z","updated_at":"2025-04-03T15:31:12.564Z","avatar_url":"https://github.com/R35007.png","language":"TypeScript","funding_links":[],"categories":["Frontend"],"sub_categories":["Templates"],"readme":"# Vite React Typescript Template\n\n![Build](https://github.com/R35007/vite-react-typescript/actions/workflows/build.yml/badge.svg) ![Lints](https://github.com/R35007/vite-react-typescript/actions/workflows/lints.yml/badge.svg) ![Tests](https://github.com/R35007/vite-react-typescript/actions/workflows/tests.yml/badge.svg) ![Cypress](https://github.com/R35007/vite-react-typescript/actions/workflows/cypress.yml/badge.svg)\n\n\u003e A simple vite react typescript starter template with husky, conventional commit, eslint, stylelint, prettier, sass, tailwindcss, material ui, tanstack routing, redux and saga, vitest and cypress\n\n## [Trying this Online!](https://codesandbox.io/p/github/R35007/vite-react-typescript/main?file=/src/main.tsx)\n\n![image](https://github.com/R35007/vite-react-typescript/assets/23217228/09dfc7f4-bf2f-4b6b-9885-3476099164ff)\n\n## Features\n\nThis template setup will include following features.\n\n| ✅  | Feature                                                                                                                                                                           | Branch Name                |\n| --- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------- |\n| ✅  | [Generate Vite](https://vitejs.dev/) + [React](https://react.dev/) + [Typescript](https://www.typescriptlang.org/)                                                                | feature/1/starter          |\n| ✅  | [Husky](https://typicode.github.io/husky/)                                                                                                                                        | feature/2/husky            |\n| ✅  | [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) + [Commitlint](https://commitlint.js.org/#/) + [Commitizen](https://commitizen-tools.github.io/commitizen/) | feature/3/commitlint       |\n| ✅  | [ESLint](https://eslint.org/)                                                                                                                                                     | feature/4/eslint           |\n| ✅  | [StyleLint](https://stylelint.io/)                                                                                                                                                | feature/5/stylelint        |\n| ✅  | [Prettier format](https://prettier.io/)                                                                                                                                           | feature/6/prettier         |\n| ✅  | [Lint Staged](https://github.com/okonet/lint-staged#readme)                                                                                                                       | feature/7/lint-staged      |\n| ✅  | [Sass](https://sass-lang.com/) + [Tailwind Css](https://tailwindcss.com/)                                                                                                         | feature/8/tailwindcss      |\n| ✅  | [Material UI](https://mui.com/)                                                                                                                                                   | feature/9/material-ui      |\n| ✅  | [Tanstack Router](https://tanstack.com/router/v1)                                                                                                                                 | feature/10/tanstack-router |\n| ✅  | [Redux](https://redux.js.org/) + [Redux Toolkit](https://redux-toolkit.js.org/)                                                                                                   | feature/11/react-redux     |\n| ✅  | [Redux Saga](https://redux-saga.js.org/)                                                                                                                                          | feature/12/react-saga      |\n| ✅  | [Vitest](https://vitest.dev/) + [RTL](https://testing-library.com/docs/react-testing-library/intro/)                                                                              | feature/13/vitest          |\n| ✅  | [Cypress](https://www.cypress.io/)                                                                                                                                                | feature/14/cypress         |\n\n## Installation\n\n```bash\n# For full template\nnpx degit R35007/vite-react-typescript#main myapp # main branch\n\n# For starter template\nnpx degit R35007/vite-react-typescript#feature/1/starter myapp # feature/1/starter branch\n```\n\n## NPM Scripts\n\n### Vite scripts\n\n```bash\nnpm run start                 # start development server\nnpm run dev                   # start development server\nnpm run build                 # build production bundle to 'dist' directly\nnpm run preview               # start production server\n```\n\n### Lint scripts\n\n```bash\nnpm run lint:scripts          # check scripts\nnpm run lint:scripts:fix      # fix scripts\nnpm run lint:styles           # check styles\nnpm run lint:styles:fix       # fix styles\nnpm run format                # check code formatting\nnpm run format:fix            # fix code formatting\nnpm run lint:ts               # check types\nnpm run lint                  # check scripts, check styles, check formats and check types\nnpm run lint:fix              # fix scripts, fix styles, fix formats and check types\nnpm run lint:staged           # does npm run lint only for staged files\n```\n\n### Test scripts\n\n```bash\nnpm run test             # run test\nnpm run test:coverage    # run test with code coverage\nnpm run cy:open          # open cypress ui\nnpm run cy:run           # run cypress test in headless mode\nnpm run cy:run:e2e       # run cypress end 2 end test in headless mode\nnpm run cy:run:component # run cypress component test in headless mode\n```\n\n### Report scripts\n\n```bash\nnpm run lint:scripts:report   # generate eslint reports in reports/eslint.html\nnpm run lint:report           # generate eslint reports\n```\n\n### Utility scripts\n\n```bash\nnpm run validate              # check scripts, check styles, check formats, check types and builds the project\nnpm run validate:fix          # fix scripts, fix styles, fix formats, check types and builds the project\nnpm run validate:staged       # does npm run lint only for staged files and builds the project\nnpm run prepare               # create Husky hooks\nnpm run clean                 # removes node_modules package-lock.json .husky dist reports\nnpm run uninstall:husky       # uninstall husky and remove .husky folder\nnpm run uninstall:tailwindcss # uninstall tailwindcss and its related plugins\nnpm run uninstall:cypress     # uninstall cypress and its related plugins and test files\nnpm run commit                # cli prompt for conventional commit\n```\n\n# License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FR35007%2Fvite-react-typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FR35007%2Fvite-react-typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FR35007%2Fvite-react-typescript/lists"}