快速开始
基础环境：
- JDK 21 ：这里使用的是azul
- MySQL 8.0.34：官网
- Maven 3.8：官网
- Redis 7.2.1：官网
- Node 20.12.2：推荐使用nvm管理node版本 nvm-windows | nvm
分支说明：
- main：主分支，用于发布稳定版本。
- dev：开发分支，用于持续集成和测试。
- {other}：其他分支，用于特定功能或修复的临时开发。
后端运行
服务运行非常简单！！
第一步：源码下载
shell
git clone https://github.com/feiyuchuixue/sz-boot-parent.gitshell
git clone https://gitee.com/feiyuchuixue/sz-boot-parent.git第二步：导入项目
这里使用的是idea
第三步：依赖安装
maven依赖导入。为了加快下载速度，在根pom配置了aliyu镜像加速，建议根据各自的网络环境灵活处置（如不需要注释即可）。
xml
<repositories>
<repository>
<id>public</id>
<url>https://maven.aliyun.com/repository/public</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
<!-- 配置官方Maven中央仓库 -->
<repository>
<id>central</id>
<url>https://repo1.maven.org/maven2</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled> <!-- 通常中央仓库不包含snapshots -->
</snapshots>
</repository>
</repositories>第四步：修改配置文件
- 打开
sz-service->sz-service-admin->resources->local目录 - 打开
mysql.yml和redis.yml， 修改配置。
在这里需要先创建数据库[如：创建数据库sz_admin_preview]（），推荐使用utf8mb4字符集。而后根据数据库信息修改jdbc配置。
修改mysql连接信息：
yaml
## mysql.yml
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/sz_admin_preview?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8&useSSL=false&allowPublicKeyRetrieval=true
username: root
password: Yanfa2023@
hikari:
#连接池名
pool-name: HikariCP
#最小空闲连接数
minimum-idle: 5
# 空闲连接存活最大时间，默认10分钟
idle-timeout: 600000
# 连接池最大连接数，默认是10
maximum-pool-size: 10
# 此属性控制从池返回的连接的默认自动提交行为,默认值：true
auto-commit: true
# 此属性控制池中连接的最长生命周期，值0表示无限生命周期，默认30分钟
max-lifetime: 1800000
# 数据库连接超时时间,默认30秒
connection-timeout: 30000
# 连接测试query
connection-test-query: SELECT 1修改redis连接信息：
yaml
## redis.yml
spring:
data:
redis:
#单机配置
host: 127.0.0.1
port: 6379
# 数据索引
database: 0
# 连接超时时间（毫秒）
timeout: 50000
###连接池配置###
jedis:
pool:
# 连接池最大连接数（使用负值表示没有限制）
max-active: 100
# 连接池最大阻塞等待时间（使用负值表示没有限制）
max-wait: -1
# 连接池中的最大空闲连接
max-idle: 30
# 连接池中的最小空闲连接
min-idle: 10
password: 123456
# 开启redis监听
redis:
listener:
enable: true至此，已经完成全部准备工作！
第五步：启动!
运行com.sz.AdminApplication.java启动文件
启动成功信息如下：
shell
2024-05-14 19:42:10.871 INFO 31360 --- [admin-service] [ main] c.sz.platform.listener.AppStartListener : ===================== app is running finish ... =====================
__ _
| ] (_)
.--. ____ ______ ,--. .--.| | _ .--..--. __ _ .--.
( (`\] [_ ]|______|`'_\ : / /'`\' | [ `.-. .-. | [ | [ `.-. |
`'.'. .' /_ // | |,| \__/ | | | | | | | | | | | | |
[\__) )[_____] \'-;__/ '.__.;__][___||__||__][___][___||__]
------------------https://szadmin.cn (v0.6.0 Beta)-------------------验证
访问 http://127.0.0.1:9991/api/admin/doc.html#/home，展示如下页面，搭建完成！！！
前端运行
第一步：源码下载
shell
git clone https://github.com/feiyuchuixue/sz-admin.gitshell
git clone https://gitee.com/feiyuchuixue/sz-admin.git第二步：导入项目
同上
第三步：依赖安装
shell
# 安装pnpm
npm install pnpm -g
# 进入到项目根路径，运行以下命令，安装依赖
pnpm install第四步：创建local环境
在项目根目录下创建 .env.development.local文件，并添加如下内容
properties
# 本地环境
VITE_USER_NODE_ENV=development
# 公共基础路径
VITE_PUBLIC_PATH=/
# 开发环境接口地址
VITE_API_URL=http://127.0.0.1:9991/api
# 授权的clientID
VITE_APP_CLIENT_ID ="195da9fcce574852b850068771cde034"
## 启用WebSocket连接
## 若需启用WebSocket，请设置VITE_SOCKET_URL为有效的WebSocket地址
## 若不设置或留空，WebSocket功能将不会启用。例：
# VITE_SOCKET_URL=ws://127.0.0.1:9993/socket第五步：启动！
打开命令行，执行 pnpm dev，项目很快启动，并弹出窗口！！ 你没看错，它只用了834ms！！！这就是vite！！
shell
VITE v4.5.2 ready in 834 ms
➜ Local: http://localhost:9848/
➜ Network: http://10.255.0.1:9848/
➜ Network: http://192.168.100.176:9848/
➜ Network: http://192.168.56.1:9848/
➜ press h to show help
输入账号密码admin/sz123456，进入home页。
注：常用命令
shell
# 运行dev环境
pnpm dev
# 打包
pnpm build
# ts类型检查
pnpm type-check
# es-lint 检查
pnpm lint
# 格式化
pnpm format