|
1 | 1 | # `@hkamran/vite-scaffold-vue-ts`
|
2 |
| -[](../../LICENSE.md) [](https://badge.fury.io/js/%40hkamran%2Fvite-scaffold-vue-ts.svg) |
| 2 | + |
| 3 | +[](../../LICENSE.md) |
| 4 | +[](https://badge.fury.io/js/%40hkamran%2Fvite-scaffold-vue-ts.svg) |
3 | 5 |
|
4 | 6 | A scaffolding system for Vite-powered Vue 3 (TypeScript) apps
|
5 | 7 |
|
6 |
| -## Installation |
7 |
| -```bash |
8 |
| -$ npm i -D @hkamran/vite-scaffold-vue-ts |
9 |
| -``` |
| 8 | +## Usage |
10 | 9 |
|
11 | 10 | ```bash
|
12 |
| -$ npx @hkamran/vite-scaffold-vue-ts |
| 11 | +npx @hkamran/vite-scaffold-vue-ts |
13 | 12 | ```
|
14 | 13 |
|
15 |
| -## Usage |
16 |
| -I recommend using this program with `npx`, via `npx @hkamran/vite-scaffold-vue-ts`. However if you would like, you can also use it by installing it, then using the `vite-scaffold-vue-ts` binary. |
17 |
| - |
18 | 14 | ### Flags
|
19 |
| -- `--npm-executable [npm executable]` (optional, defaults to `npm`): The NPM executable to use |
20 |
| -- `--styling`: Install [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) and configure them |
21 |
| -- `--vite-html`: Install [`vite-plugin-html-config`](https://github.com/ahwgs/vite-plugin-html-config) to manage HTML head tags and configure it |
22 |
| -- `--router`: Install [`vue-router`](https://router.vuejs.org/) and configure it |
23 |
| -- `--tailwindcss`: Install [Tailwind CSS](https://tailwindcss.com/) and configure it |
| 15 | + |
| 16 | +- `--npm-executable [npm executable]` (optional, defaults to `npm`): The `npm` executable |
| 17 | + to use (e.g. `npm`, [`pnpm`](https://pnpm.io), or [`yarn`](https://yarnpkg.com)) |
| 18 | +- `--styling`: Install and configure [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) |
| 19 | +- `--vite-html`: Install and configure [`vite-plugin-html-config`](https://github.com/ahwgs/vite-plugin-html-config) |
| 20 | + to manage HTML head tags |
| 21 | +- `--router`: Install and configure [`vue-router`](https://router.vuejs.org/) |
| 22 | +- `--tailwindcss`: Install and configure [Tailwind CSS](https://tailwindcss.com/) |
24 | 23 | - `--netlify`: Add the Netlify [`_redirects` file](https://docs.netlify.com/routing/redirects/)
|
25 |
| -- `--disallow-robots`: Add a `robots.txt` that disallows all bots (omitting this flag will add the version that allows all) |
| 24 | +- `--disallow-robots`: Add a `robots.txt` that disallows all bots (omitting this |
| 25 | + flag will add the version that allows all) |
26 | 26 | - `--verbose`: Show output
|
0 commit comments