|
| 1 | +--- |
| 2 | +id: vue-wizard-template |
| 3 | +title: Vue Wizard Template |
| 4 | +sidebar_label: Vue Wizard |
| 5 | +--- |
| 6 | + |
| 7 | +<!-- @format --> |
| 8 | + |
| 9 | +This template provides a comprehensive setup for a modern Vue.js project, designed to get you up and running with a full-featured development environment and best practices out of the box. |
| 10 | + |
| 11 | +## Features |
| 12 | + |
| 13 | +- **Vue 3**: Utilizes the latest Vue.js version with Composition API and `<script setup>` syntax. |
| 14 | +- **Vite**: A lightning-fast development server and build tool. |
| 15 | +- **TypeScript**: Full TypeScript integration for type safety. |
| 16 | +- **Vue Router**: For client-side routing. |
| 17 | +- **Pinia**: For state management. |
| 18 | +- **ESLint & Prettier**: For code linting and formatting. |
| 19 | +- **Vitest**: For unit testing. |
| 20 | +- **GitHub Integration**: Includes workflows for CI/CD, GitHub Pages deployment, and release drafting. |
| 21 | +- **Dark/Light Mode**: A built-in theme switcher. |
| 22 | +- **Responsive UI**: Comes with a preset responsive layout, including a navigation bar and footer. |
| 23 | + |
| 24 | +## Interactive Setup |
| 25 | + |
| 26 | +When you select the `vue-wizard` template, the CLI will guide you through an interactive setup process, allowing you to customize your project with the following options: |
| 27 | + |
| 28 | +- **Public GitHub Repository**: Choose whether to make your new repository public. |
| 29 | +- **LICENSE File**: Add a `LICENSE` file (MIT by default). |
| 30 | +- **FUNDING.yml**: Add a `FUNDING.yml` file to your GitHub repository. |
| 31 | +- **`docs/` Directory**: Set up a `docs/` directory for your project documentation. |
| 32 | +- **GitHub Pages Workflow**: Include a workflow to automatically deploy your project to GitHub Pages. |
| 33 | + |
| 34 | +## Available Scripts |
| 35 | + |
| 36 | +- `npm run dev`: Starts the development server. |
| 37 | +- `npm run build`: Builds the app for production. |
| 38 | +- `npm run preview`: Previews the production build locally. |
| 39 | +- `npm run test`: Runs the unit tests. |
| 40 | +- `npm run lint`: Lints the code. |
| 41 | +- `npm run format`: Formats the code with Prettier. |
| 42 | +- `npm run typecheck`: Checks for TypeScript errors. |
| 43 | +- `npm run version`: Updates the project version. |
0 commit comments