快速开始
欢迎使用 ViteKit CLI!这个指南将帮助您快速上手并创建您的第一个项目。
安装
全局安装(推荐)
bash
npm i -g vitekit-cli
使用 npx(无需安装)
bash
npx vitekit-cli my-project
创建项目
安装完成后,您可以使用以下命令创建新项目:
bash
vitekit my-project
这将会:
- 创建一个名为
my-project的新目录 - 下载并设置项目模板
- 安装所有必要的依赖
- 初始化 Git 仓库
启动开发服务器
进入项目目录并启动开发服务器:
bash
cd my-project
npm run dev
现在您可以在浏览器中打开 http://localhost:5173 查看您的项目!
项目结构
创建的项目具有以下结构:
my-project/
├── public/ # 静态资源
│ └── favicon.ico
├── src/ # 源代码
│ ├── assets/ # 资源文件
│ ├── components/ # Vue 组件
│ ├── router/ # 路由配置
│ ├── stores/ # 状态管理
│ ├── styles/ # 样式文件
│ ├── utils/ # 工具函数
│ ├── App.vue # 根组件
│ └── main.ts # 入口文件
├── index.html # HTML 模板
├── package.json # 项目配置
├── tsconfig.json # TypeScript 配置
├── vite.config.ts # Vite 配置
└── README.md # 项目说明
可用脚本
在项目目录中,您可以运行以下命令:
npm run dev
启动开发服务器,支持热重载。
npm run build
构建生产版本到 dist 目录。
npm run preview
预览生产构建版本。
npm run lint
运行 ESLint 检查代码质量。
npm run lint:fix
运行 ESLint 检查代码质量并自动修复问题。
ViteKit CLI