{"_id":"@anivive/create-vue3-package","_rev":"21-dbf668d06a459826135ade59c58d21c1","name":"@anivive/create-vue3-package","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@anivive/create-vue3-package","version":"1.0.0","keywords":["cli","create-package","vue","vue-3","typescript","eslint","jest","docsify"],"author":{"url":"https://github.com/SkylerStearns","name":"Skyler Stearns"},"license":"MIT","_id":"@anivive/create-vue3-package@1.0.0","maintainers":[{"name":"dan2kx","email":"dmcgowan@anivive.com"},{"name":"skyler.stearns","email":"skyler@anivive.com"},{"name":"sirago","email":"nick@sirago.org"}],"contributors":[{"url":"https://github.com/dan2kx","name":"Dan McGowan"},{"url":"https://github.com/sirago","name":"Nick Sirago"}],"homepage":"https://github.com/Anivive/create-vue3-package#readme","bugs":{"url":"https://github.com/Anivive/create-vue3-package/issues"},"bin":{"create-vue3-package":"bin/create-package"},"dist":{"shasum":"bb6dce4495eab720af0e3500f97244e0465b3ab8","tarball":"https://registry.npmjs.org/@anivive/create-vue3-package/-/create-vue3-package-1.0.0.tgz","fileCount":34,"integrity":"sha512-ecVuDajywl/zwZtKE/IS6BMgZ0O57G0tWUNHguJXKSewE6eWLdTfS3iNfWjjlNQZfgbuHdxDEUfW1c499Qsnxw==","signatures":[{"sig":"MEUCIQCSzdwbuqlMPgTuR0l8gljXSESI2gGMr+LiMC0ctcaLNAIgULXlMFcMZCMbp7xQBDJF7BKoOKmTZfA4YocL/nzKneM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":44475,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgFJGiCRA9TVsSAnZWagAASbQQAKLfKsUfvCuqgDbYjvq0\nni+M9JFxxELx5NMIHdmRMyGH8nhi/sU/0BPN3DnK42+6uFU1m+JTvj1g+qYr\n28sr+LFC9FZmUvpP0d+SbO9EdL015Na4Bc3e8W6dXMH/cPvMiyE5jZ89X6D9\n7e4Wdb1BNgMyX5i27EC1U7eXemD7HhJTuwXiFX2BEzR05gGZKI2XRAG3DTtP\nJSiGi7HUHR8Zdad1KqS/QzoM84HMsO6y0qE8qAJYfpSPl1LAiy5m9CT6wCXo\n2AZeHKP6TP7mu1t6iNchEzd1M7jMIrDLLDmrpd9+1D4R8sefb+KyQlyl6Qxh\njSxBWvuuwIn3xDukCUSvNmcAaqwkcDlz7gY356W7AAq5sbph2932mIlkZryU\n+FFYVeNVr88DUG5ooC+XUnrEPfNFG+BjK+wCr1nQbCpsvTO2/DgPIZkDJKoT\nqbsZLj1iWhENpZiv0tcBTR6961Bgljz1C1Qx9ujDnidGxMORmkMECS+8uMNq\nMqUbiUjco7PydEUDQS4SZSB+q+TeLYTz2j2kZPeejfG51mqRoDU8fstZ99vo\nOnnOwMzifVNvyJpJRWkmI+qxVNDLcTtroejiBCmVWuiglCBlzf/NO3Ei4UjZ\nXv479Hbye3sxjiGVTmDeF3EucBnnyWTUKGFlwvKeOlYyQAeldpZNeamGglz0\nYa2f\r\n=B11M\r\n-----END PGP SIGNATURE-----\r\n"},"main":"src/index.js","gitHead":"74ce7046fcdf95b00c99ce9cd29c53990bca8145","private":false,"scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"sirago","email":"nick@sirago.org"},"repository":{"url":"git+https://github.com/Anivive/create-vue3-package.git","type":"git"},"_npmVersion":"7.3.0","description":"To assist developers in starting a Vue 3 package with basic file structure and dependencies to get started quickly and efficiently.","directories":{"test":"tests"},"_nodeVersion":"15.5.1","dependencies":{"arg":"^5.0.0","esm":"^3.2.25","ncp":"^2.0.0","chalk":"^4.1.0","execa":"^5.0.0","listr":"^0.14.3","inquirer":"^7.3.3","pkg-install":"^1.0.0"},"organization":"Anivive Lifesciences Inc.","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/create-vue3-package_1.0.0_1611960738106_0.9353206116373383","host":"s3://npm-registry-packages"}}},"time":{"created":"2021-01-29T22:52:17.827Z","modified":"2026-04-21T17:05:21.732Z","1.0.0":"2021-01-29T22:52:18.248Z"},"bugs":{"url":"https://github.com/Anivive/create-vue3-package/issues"},"author":{"url":"https://github.com/SkylerStearns","name":"Skyler Stearns"},"license":"MIT","homepage":"https://github.com/Anivive/create-vue3-package#readme","keywords":["cli","create-package","vue","vue-3","typescript","eslint","jest","docsify"],"repository":{"url":"git+https://github.com/Anivive/create-vue3-package.git","type":"git"},"description":"To assist developers in starting a Vue 3 package with basic file structure and dependencies to get started quickly and efficiently.","contributors":[{"url":"https://github.com/dan2kx","name":"Dan McGowan"},{"url":"https://github.com/sirago","name":"Nick Sirago"}],"maintainers":[{"email":"carchuleta@anivive.com","name":"anivive-cameron"},{"email":"jhager@anivive.com","name":"jhager_anivive"},{"email":"itadmin@anivive.com","name":"anivive_bot"},{"email":"skyler@anivive.com","name":"skyler.stearns"},{"email":"dmcgowan@anivive.com","name":"dan2kx"},{"email":"cody@anivive.com","name":"codyanivive"},{"email":"sfacista@anivive.com","name":"sfacista"}],"readme":"<div style=\"text-align:center\" align=\"center\">\n\n![Package Logo](assets/vue-ts-eslint-jest.png)\n\n# Vue 3 Package Starter\n\nVue Starter Package integrated with Typescript and Eslint\n\nAutomated unit testing with Jest\n\nAuto-generated documentation via Docsify\n\n[![Vue](https://img.shields.io/badge/vue-3.0.5-%2342b883)](https://v3.vuejs.org/)\n[![Typescript](https://img.shields.io/badge/typescript-4.1.3-blue)](https://www.typescriptlang.org/)\n[![Jest](https://img.shields.io/badge/jest-26.6.3-red)](https://jestjs.io/en/)\n[![Docsify](https://img.shields.io/badge/docsify-4.11.6-green)](https://docsify.js.org/#/)\n\n</div>\n\n\n\n## Getting Started\n\n#### Install necessary dependencies:\n```\nnpm install\n```\n\n#### Create new project\n```\nnpx create-vue3-package <repo-name>\n```\n\n#### Initiate test suite\n```\nnpm test\n```\n\n#### Serve docs\n```\nnpm run docs\n\nvisit -> http://localhost:3000\n```\n\n\n## Table of Contents\n\n* [Overview](#vue-3-package-starter)\n* [Getting Started](#getting-started)\n* [Table of Contents](#table-of-contents)\n* [What's in this Package?](#whats-in-this-package)\n* [Testing](#testing)\n* [Documentation](#documentation)\n* [How to Open Source Your Project](#how-to-open-source-your-project)\n* [Contributing Guidelines](#contributing-guidelines)\n* [Code Of Conduct](#code-of-conduct)\n* [Bugs and Feature Requests](#bugs-and-feature-requests)\n* [Copyright and License](#copyright-and-license)\n\n\n\n## What's in this Package?\n\n```\ncreate-vue3-package\n├── templates\n│   └── ISSUE_TEMPLATE\n│       └── bug_report.md\n│       └── feature_request.md\n│   └── CODE_OF_CONDUCT.md\n│   └── CONTRIBUTING.md\n│   └── LICENSE.md\n│   └── PULL_REQUEST_TEMPLATE.md\n│   └── README_TEMPLATE.md\n│   └── src\n│       └── main.ts\n│       └── main.vue\n│   └── tests\n│       └── example-ts-file.test.js\n│       └── example-vue-file.test.js\n│   └── docs\n│       └── customization\n│           └── configuration.md\n│           └── themes.md\n│       └── getting_started\n│           └── more-pages.md\n│           └── quickstart.md\n│       └── guides\n│           └── deploy.md\n│           └── helpers.md\n│       └── .nojekyll\n│       └── _sidebar.md\n│       └── changelog.md\n│       └── index.html\n│       └── README.md\n```\n\n\n\n## Testing\nTo expand on the test suite, add your test files to the `/tests` directory, and Jest will\nautomatically pick them up.\n\nThis package has been pre-configured to test `.js`, `.ts`, and `.vue` files for your convenience.\nPlease see `/templates/tests` for example implementation. \n\nTo run your automated tests, run the commands below in your terminal:\n```\ncd <repo-name>\n\nnpm test\n```\nIf you would like to have an HTML file generated to view the results in more detail, please\nuncomment the line 'html' in `jest.config.js`. Otherwise, the results will be visible in your\nterminal.\n\n\n[Jest Documentation](https://jestjs.io/docs/en/getting-started)\n\n\n\n## Documentation\nThis package is set up to use Docsify, a documentation generator that creates a website portal for\nyou and your team to view all of your documentation automatically.\n\nYour documentation README files are located in the `/docs` directory.\n```\n/docs/README.md                 ==> landing page for your documentation portal\n/docs/_sidebar.md               ==> displays your documentation archictecture\n/docs/changelog.md              ==> references your documentation updates\n/docs/customization/            ==> example folder\n/docs/getting_started/          ==> example folder\n/docs/guides/                   ==> example folder\n```\n\nIn order to view your documentation, run the commands below in your terminal:\n```\nnpm i docsify-cli -g\n\ncd <repo-name>\n\nnpm run docs\n```\n\nView your documentation at: `http://localhost:3000`\n\n[Docsify Documentation](https://docsify.js.org/#/quickstart)\n\n\n\n## How to Open Source Your Project\n\nIf you are looking to open source this project, we've created some template documentation for you\nto get the ball rolling:\n* MIT License\n* Contributing Guidelines\n* Code of Conduct\n* Pull Request Template\n* Bug Report Template\n* Feature Request Template\n\n\nFor more information on creating an open source project and best practices, here are some helpful\nresources to get you started:\n* [Open Source Guides](https://opensource.guide/starting-a-project/)\n* [Github Learning Lab - Create an open source program](https://lab.github.com/githubtraining/create-an-open-source-program)\n\n\n\n## Contributing Guidelines\nPlease read through our [contributing guidelines](.github/CONTRIBUTING.md). Included are directions\nfor opening issues, coding standards, and notes on development.\n\nMoreover, if your pull request contains JavaScript patches or features, you must include relevant\nunit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.\n\n\n\n## Code of Conduct\nPlease read through our [code of conduct](CODE_OF_CONDUCT.md).\n\n\n\n## Bugs and Feature Requests\nFound a bug or have a feature request? Please first read the issue guidelines and search for\nexisting and closed issues.\n\nIf your problem or idea is not addressed yet, please\n[open a new issue](https://github.com/Anivive/vue-package-starter/issues).\n\n\n\n## Copyright and License\nCode and documentation copyright 2021 Anivive Lifesciences Code released under the [MIT License](LICENSE.md).\n\nDocs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).\n\nPlease note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).\nBy participating in this project you agree to abide by its terms.\n\n\n\n---\n\n\n\nStatus badges created using [Shields.io](https://github.com/badges/shields).\n","readmeFilename":"README.md"}