准备工作
源码
阅读开发文档前,请确保手上已经有 Kpu-admin 源码,因为文档中提及的内容,都是需要在本地项目中编写或修改代码并运行才能呈现的。
到 Github Releases 页面下载最新版本的压缩包,如下图所示:
或者也可以从 Github/Gitee 上拉取源码,但需要注意,直接拉取源码可能会包含未发布的内容,最终发布时可能会有变动,请谨慎使用。
sh
# 拉取框架源码
git clone https://github.com/Kpu-admin/web.git
# 拉取演示源码
git clone -b example https://github.com/Kpu-admin/web.git
sh
# 拉取框架源码
git clone https://gitee.com/Kpu-admin/web.git
# 拉取演示源码
git clone -b example https://gitee.com/Kpu-admin/web.git
开发环境
使用本模板前,需要在本地依次安装好 Node.js, pnpm, Git(非必须) 和 Visual Studio Code。
注意
- 在 package.json 文件中有限制 node 要求版本,建议使用最新 LTS 版本。
- 如果你不想使用 VSCode ,我们也强烈建议你使用基于 VSCode 内核的 IDE ,如 Cursor 。
然后在 Visual Studio Code 里安装好以下扩展:
在 Visual Studio Code 里打开源码文件夹,右下角会自动提示需要安装的依赖,直接点击安装即可。
额外推荐
以上为开发时必备扩展,以下则是作者推荐安装的扩展,安装它们将在一定程度上提升开发效率。
- Chinese (Simplified) Language Pack for Visual Studio Code 中文语言包
- Color Highlight 在代码中高亮颜色
- Highlight Matching Tag 高亮显示匹配的标签
- Image preview 图片预览
- indent-rainbow 彩虹缩进提示
技术栈
了解并熟悉框架使用到的技术栈,能让你使用本框架更得心应手。