【Vue3 + TS + Vite】从0到1搭建项目框架

前言

没搭建过Vue3的项目,从0开始搭建一下,记录一下自己的步骤。
技术栈vue3 + ts + scss + pinia + vite
我尽量写的详细一些,后续也会记录我在项目过程中,遇到的一些问题。

文章目录

  • 前言
  • 环境搭建
    • 一、创建项目
        • 1. 使用 Vite 创建 Vue 3 + TypeScript 项目:
        • 2. 进入项目目录:
        • 3. 安装项目依赖:
    • 二、项目结构规划
        • 1.项目的初始结构
        • 2. 通常可以创建以下目录结构:
    • 三、配置 Pinia
        • 1. 安装 Pinia:
        • 2. 创建 Pinia 实例:
        • 3. 在`main.ts`文件中引入 Pinia 实例:
        • 4. 在`src/store`文件夹下创建不同的 store 文件,例如`userStore.ts`用于管理用户状态:
        • 5. 在组件中使用 store:
    • 四、路由配置
        • 1. 安装`vue-router`:
        • 2. 创建路由模块:
    • 五、安装 less/scss
        • 1. 安装 scss and sass 依赖
        • 2. 安装 less 依赖
    • 六、安装 Element Plus
        • 1. 安装 Element Plus(一个流行的 Vue UI 组件库):
        • 2. 引入 Element Plus:在 main.ts 文件中引入并配置。
    • 七、请求数据(Axios 为例)
        • 1. 安装 Axios:
        • 2. 创建请求封装:
        • 3. 在 store 或组件中使用请求:
    • 八、构建和部署
        • 1. 开发完成后,可以使用以下命令进行构建:
        • 2. 根据你的部署环境进行相应的部署操作,如将构建后的文件部署到服务器上。

环境搭建

在搭建之前请确认几点:
1.创建的项目将使用基于 Vite 的构建设置;
2.确保安装了最新版本的 Node.js,可以从官方网站下载并安装;
3.当前工作目录正是打算创建项目的目录。

一、创建项目

1. 使用 Vite 创建 Vue 3 + TypeScript 项目:
  • npm:
   npm create vite@latest
  • yarn:
yarn create vite

在这里插入图片描述

  • Project name : 自己写一个就行,用英文(这个原因不用说吧)
  • Select a framework:用键盘上下键选择就行,选到 Vue 回车
  • Select a variant:我想尝试一下ts,所以这里选了 typescript,按照自己的需求选择
    这里我用 yarn ,命令创建项目,后面安装一些依赖,也是用 yarn

大家注意统一,要么一直用 npm , 要么一直用 yarn
这里给大家推荐一个博主原创的博客 —— yarn安装与使用

2. 进入项目目录:
cd my_demo_proj
3. 安装项目依赖:
yarn

在这里插入图片描述

二、项目结构规划

1.项目的初始结构

在这里插入图片描述

2. 通常可以创建以下目录结构:
  • src/components :存放可复用的组件。
  • src/views :存放页面组件,例如Dashboard.vue用于仪表盘页面等。
  • src/api :用于封装与后端 API 的交互。
  • src/router :路由配置。
  • src/store :状态管理。
  • src/styles :全局样式。
    按照自己的习惯来,且合理就行。还是把我创建的目录结构贴在这,方便我后期看。
    在这里插入图片描述

三、配置 Pinia

1. 安装 Pinia:
  • npm:
   npm install pinia
  • yarn:
yarn add pinia

在这里插入图片描述

pinia 拥抱 ts 会比 vuex 好一些,pinia中文官网

2. 创建 Pinia 实例:

在项目的src目录下创建一个名为store的文件夹,然后在该文件夹中创建一个index.ts文件,添加以下内容:

import {
   
    createPinia } from 'pinia';

const pinia = createPinia();

export default pinia;
3. 在main.ts文件中引入 Pinia 实例:
import {
   
    createApp } from 
### 如何设置一个基于 ViteVue3TypeScript项目 通过 `npm` 创建并配置一个支持 Vue3TypeScriptVite 项目是一个相对简单的过程。以下是详细的说明: #### 安装依赖项 首先,安装必要的插件来扩展项目的功能。例如,为了增强 Vue 组件的功能,可以使用 `vite-plugin-vue-setup-extend` 插件[^1]。 ```bash npm install -D vite-plugin-vue-setup-extend ``` 此命令会将该插件作为开发依赖项添加到项目中。 --- #### 初始化 Vite 项目 要快速搭建一个基础的 Vite + Vue3 + TypeScript 工程,可以通过以下方式完成初始环境的构建[^4]: ```bash npm create vite@latest my-project --template vue-ts cd my-project npm install ``` 上述命令中的模板选项 (`--template vue-ts`) 自动集成了 Vue3TypeScript 支持,从而减少了手动配置的工作量。 --- #### 配置文件调整 在初始化完成后,需要对 `vite.config.ts` 文件进行适当修改以满足特定需求[^2]。默认情况下,Vite 提供了一个基本的配置结构,可以根据实际场景进一步优化。例如,在引入额外插件时,可以在配置文件中加入如下内容: ```typescript import { defineConfig } from 'vite' import vue from '@vitejs/plugin-vue' import vitePluginVueSetupExtend from 'vite-plugin-vue-setup-extend' export default defineConfig({ plugins: [ vue(), vitePluginVueSetupExtend() ] }) ``` 这段代码片段展示了如何加载核心插件以及之前提到的辅助插件。 --- #### 处理常见错误 当项目涉及 `.ts` 文件与 `.vue` 文件之间的交互时,可能会遇到一些兼容性问题[^3]。解决方法通常包括更新 tsconfig.json 设置或者安装类型声明包 (type declaration packages),比如 @types/vue 或其他相关库。 --- #### 启动和构建项目 一旦所有前期工作都已完成,则可通过标准脚本启动本地服务器或执行生产版本打包操作: ```bash npm run dev # 开发模式下运行应用 npm run build # 构建最终产物用于部署 ``` 这些命令分别对应于调试阶段的服务启动以及正式上线前的资源压缩过程。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

菜鸟una

客官打赏小银子,我库库出文

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值