{"_id":"@castromaciellr/template-vite-react-ts","_rev":"1-9341aac2fecdee4b85e45be4216abbc4","name":"@castromaciellr/template-vite-react-ts","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@castromaciellr/template-vite-react-ts","private":false,"bin":{"template-vite-react-ts":"bin/cli.js"},"description":"A custom Vite + React + TS template, using vitest for testing","author":{"name":"Castro Maciel"},"keywords":["React","Typescript","Vite","React template"],"version":"1.0.0","type":"module","license":"MIT","repository":{"type":"git","url":"git+https://github.com/castromaciel/template-vite-react-ts.git"},"publishConfig":{"access":"public"},"scripts":{"build":"npm run lint && tsc && vite build","coverage":"vitest run --coverage","dev":"vite","lint":"eslint src/**/*.{ts,tsx}","preview":"vite preview","start":"vite","test":"vitest --run","test:watch":"vitest","prepare":"husky install"},"dependencies":{"axios":"^1.2.6","react":"^18.2.0","react-dom":"^18.2.0"},"devDependencies":{"@testing-library/dom":"^9.2.0","@testing-library/jest-dom":"^5.16.5","@testing-library/react":"^13.4.0","@testing-library/user-event":"^14.4.3","@types/jest":"^29.4.0","@types/node":"^18.7.6","@types/react":"^18.0.26","@types/react-dom":"^18.0.9","@types/testing-library__jest-dom":"^5.14.6","@typescript-eslint/eslint-plugin":"^5.36.1","@typescript-eslint/parser":"^5.36.1","@vitejs/plugin-react":"^3.1.0","@vitest/coverage-istanbul":"^0.30.1","eslint":"^8.2.0","eslint-config-airbnb":"19.0.4","eslint-import-resolver-typescript":"^3.5.5","eslint-plugin-import":"^2.25.3","eslint-plugin-jsx-a11y":"^6.5.1","eslint-plugin-react":"^7.28.0","eslint-plugin-react-hooks":"^4.3.0","husky":"^8.0.3","jsdom":"latest","lint-staged":"^13.2.2","sass":"^1.54.4","typescript":"^4.9.3","vite":"^4.0.0","vitest":"^0.29.8"},"gitHead":"095e07618c6d22c284840cf07c1ac6142e62a0d8","bugs":{"url":"https://github.com/castromaciel/template-vite-react-ts/issues"},"homepage":"https://github.com/castromaciel/template-vite-react-ts#readme","_id":"@castromaciellr/template-vite-react-ts@1.0.0","_nodeVersion":"16.16.0","_npmVersion":"8.11.0","dist":{"integrity":"sha512-4+WxTHYhBN+l8VIHJj9Ls9A8dB5BzQ+q5nBal1pm5ntUxDStuhmYZehcpDOvb3I/r5sBPI1Tf5p7FPJmaw06Ng==","shasum":"817a602a7b384147e7760070286c44b50b9628fe","tarball":"https://registry.npmjs.org/@castromaciellr/template-vite-react-ts/-/template-vite-react-ts-1.0.0.tgz","fileCount":35,"unpackedSize":31465,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICjKiue4M1PcnWju840QlgK7Hi8sjtPJa1s/OU368YBBAiADGi+ZcdXSk5QmO8DEDpV5xFnxrYt1cNSO9pV+W08tWA=="}]},"_npmUser":{"name":"castromaciellr","email":"castromaciel00@gmail.com"},"directories":{},"maintainers":[{"name":"castromaciellr","email":"castromaciel00@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/template-vite-react-ts_1.0.0_1688011828947_0.5330235115209581"},"_hasShrinkwrap":false},"1.0.1":{"name":"@castromaciellr/template-vite-react-ts","private":false,"bin":{"template-vite-react-ts":"bin/cli.js"},"description":"A custom Vite + React + TS template, using vitest for testing","author":{"name":"Castro Maciel"},"keywords":["React","Typescript","Vite","React template"],"version":"1.0.1","type":"module","license":"MIT","repository":{"type":"git","url":"git+https://github.com/castromaciel/template-vite-react-ts.git"},"publishConfig":{"access":"public"},"scripts":{"build":"npm run lint && tsc && vite build","coverage":"vitest run --coverage","dev":"vite","lint":"eslint src/**/*.{ts,tsx}","preview":"vite preview","start":"vite","test":"vitest --run","test:watch":"vitest","prepare":"husky install"},"dependencies":{"axios":"^1.2.6","react":"^18.2.0","react-dom":"^18.2.0"},"devDependencies":{"@testing-library/dom":"^9.2.0","@testing-library/jest-dom":"^5.16.5","@testing-library/react":"^13.4.0","@testing-library/user-event":"^14.4.3","@types/jest":"^29.4.0","@types/node":"^18.7.6","@types/react":"^18.0.26","@types/react-dom":"^18.0.9","@types/testing-library__jest-dom":"^5.14.6","@typescript-eslint/eslint-plugin":"^5.36.1","@typescript-eslint/parser":"^5.36.1","@vitejs/plugin-react":"^3.1.0","@vitest/coverage-istanbul":"^0.30.1","eslint":"^8.2.0","eslint-config-airbnb":"19.0.4","eslint-import-resolver-typescript":"^3.5.5","eslint-plugin-import":"^2.25.3","eslint-plugin-jsx-a11y":"^6.5.1","eslint-plugin-react":"^7.28.0","eslint-plugin-react-hooks":"^4.3.0","husky":"^8.0.3","jsdom":"latest","lint-staged":"^13.2.2","sass":"^1.54.4","typescript":"^4.9.3","vite":"^4.0.0","vitest":"^0.30.0"},"gitHead":"095e07618c6d22c284840cf07c1ac6142e62a0d8","bugs":{"url":"https://github.com/castromaciel/template-vite-react-ts/issues"},"homepage":"https://github.com/castromaciel/template-vite-react-ts#readme","_id":"@castromaciellr/template-vite-react-ts@1.0.1","_nodeVersion":"16.16.0","_npmVersion":"8.11.0","dist":{"integrity":"sha512-BWF9iq9JjUwhOiyzV9PkTblCPf1iOpduC8/M0zWvVK8HZarNW/fiW4vfkAUVbADYg5Fx3IQdCgKHsGJTR08Uwg==","shasum":"f3c443043f6a1c5ecbbb9690053e0d4dea31db81","tarball":"https://registry.npmjs.org/@castromaciellr/template-vite-react-ts/-/template-vite-react-ts-1.0.1.tgz","fileCount":35,"unpackedSize":31477,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAioW6OttDRUFgpQ2CDPo9MhUllXJkSlmN5PiGjidUsgAiEA91/pbR5bWk1xPVhoD5NIgsfvKiOv1Rmzy7kUw2b167o="}]},"_npmUser":{"name":"castromaciellr","email":"castromaciel00@gmail.com"},"directories":{},"maintainers":[{"name":"castromaciellr","email":"castromaciel00@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/template-vite-react-ts_1.0.1_1688011996347_0.805778707839875"},"_hasShrinkwrap":false}},"time":{"created":"2023-06-29T04:10:28.853Z","1.0.0":"2023-06-29T04:10:29.132Z","modified":"2023-06-29T04:13:16.676Z","1.0.1":"2023-06-29T04:13:16.521Z"},"maintainers":[{"name":"castromaciellr","email":"castromaciel00@gmail.com"}],"description":"A custom Vite + React + TS template, using vitest for testing","homepage":"https://github.com/castromaciel/template-vite-react-ts#readme","keywords":["React","Typescript","Vite","React template"],"repository":{"type":"git","url":"git+https://github.com/castromaciel/template-vite-react-ts.git"},"author":{"name":"Castro Maciel"},"bugs":{"url":"https://github.com/castromaciel/template-vite-react-ts/issues"},"license":"MIT","readme":"\nTemplate: Vite + Vitest + React + TypeScript\n
\n\n\n\n  \n\n
\n\n## Usage\n\n### Use Template button\nClick the `Use this template` button above the file list, then use the Owner drop-down menu, and select the account you want to own the repository. Creating a repository from a template has the following advantages:\n\nA repository created from a template starts with a single commit.\nCommits to a repository created from a template do appear in your contribution graph.\nCreating a repository from a template starts a new project quickly.\n\n\n## Development\n\n### Prerequisites\n\n* [Node js](https://nodejs.org/en)\n\n### Recommended\n\n* [pnpm](https://pnpm.io/) \n* [Node js - v16.x.x](https://nodejs.org/en/blog/release/v16.16.0)\n\n### Make it your own\n\nTo get a local copy, clone it using:\n```sh\ngit clone https://github.com/castromaciel/template-vite-react-ts.git\n```\n\nOr get it downloading\n\n```sh\nrm -rf .git && git init\ngit add .\ngit commit -m \"Initial commit\"\n```\n\n### Install dependencies:\n\nTo install dependencies use one of the following commands:\n\n```sh\nnpm install\n```\n\n```sh\nyarn install\n```\n\n```sh\npnpm install\n```\n\n### Available Scripts\n\nIn this project, you can run the following scripts:\n\n| Script | Description |\n| ------------- | --------------------------------------------------- |\n| npm run build | Builds the app for production to the `dist` folder. |\n| npm run coverage | Runs tests with code coverage |\n| npm run dev | Runs the app in the development mode. |\n| npm run preview | Start a local web server that serves the built solution from ./dist for previewing |\n| npm run prepare | Install husky githooks |\n| npm run test | Runs tests with vitest. |\n\n## Base Dependencies\n\n- [axios](https://github.com/axios/axios) for networking.\n- [sass](https://sass-lang.com/) for stylesheets.\n- [vitest](https://vitest.dev/) for testing.\n\n## Folder Structure\n\n```\ntemplate-vite-react-ts\n├── .github\n ├── workflows\n├── .husky\n ├── pre-commit\n ├── pre-push\n├── node_modules\n├── public\n│ └── vite.svg\n└── src\n ├── __tests__\n ├── App.test.tsx\n ├── assets\n ├── react.svg\n ├── components\n ├── constants\n ├── index.ts\n ├── App.scss\n ├── App.tsx\n ├── index.scss\n ├── main.tsx\n └── vite-env.d.ts\n├── .env.development\n├── .eslintignore\n├── .eslintrc.json\n├── .gitattributes\n├── .gitignore\n├── .lintstagedrc\n├── .npmrc\n├── index.html\n├── LICENSE\n├── package.json\n├── pnpm-lock.yaml\n├── README.md\n├── tsconfig.json\n├── tsconfig.node.json\n├── vite.config.js\n├── vitest.config.js\n```\n\n## husky config\n\nTo create husky githooks, you need to run `npm prepare` or `pnpm prepare`, and then configure your githooks with \n\n```sh\nnpx husky add .husky/ \"command you want to configure\"\n```\n\nFor example, the initial config has been created with: \n```sh\nnpx husky add .husky/pre-commit \"npx lint-staged\"\n```\n\n```sh\nnpx husky add .husky/pre-push \"pnpm test\"\n```\n\nYou are free to modify the configuration.\n\n\n## Styleguide\n\nFor coding styling, I decided to use [eslint](https://eslint.org/) and the [eslint-airbnb configuration](https://github.com/airbnb/javascript#readme), with some personal modifications.\n\n## Credits\n\nVite Template React with TypeScript is built and maintained by [Castro Maciel](https://github.com/castromaciel)\n\n## License\n\nThis project is licensed under the terms of the [MIT license](./LICENSE).\n","readmeFilename":"README.md"}