Geeker-Admin

Appearance

On this page

快速上手 ​

本文会帮助你从头启动、搭建此项目

环境准备 ​

本地环境需要安装 Node.js 16.x+、pnpm 7.x+、Git

WARNING

Node.js 版本推荐安装 16+ 以上，版本过低依赖包可能安装失败。

默认使用 pnpm 作为安装依赖包工具，使用 yarn、npm 没有 lock 可能会安装到最新版依赖。

工具配置 ​

本项目推荐使用 VSCode 进行开发，项目里面已内置 VSCode 配置，包含推荐的插件和设置。

🌈 推荐安装以下插件：

.vscode > extensions.json ​

json
{
	"recommendations": ["vue.volar", "vue.vscode-typescript-vue-plugin", "hollowtree.vue-snippets", "dbaeumer.vscode-eslint", "stylelint.vscode-stylelint", "esbenp.prettier-vscode", "editorconfig.editorconfig", "streetsidesoftware.code-spell-checker", "syler.sass-indented", "mikestead.dotenv"]
}

WARNING

  • 开发 Vue3 项目请开启 Volar 插件、禁用 Vetur 插件。
  • 请配置项目默认格式化程序为 Prettier。

代码拉取 ​

从 Gitee 拉取代码： ​

bash
# 克隆代码
git clone https://gitee.com/HalseySpicy/Geeker-Admin.git

从 GitHub 拉取代码： ​

bash
# 克隆代码
git clone https://github.com/HalseySpicy/Geeker-Admin.git

安装使用步骤 ​

安装依赖： ​

bash
# 使用 pnpm
pnpm install

运行项目： ​

bash
# 以下两个命令都可以
pnpm dev
pnpm serve

打包项目： ​

bash
# 开发环境
pnpm build:dev

# 测试环境
pnpm build:test

# 生产环境
pnpm build:pro

校验、格式化代码： ​

bash
# eslint 检测代码
pnpm lint:eslint

# prettier 格式化代码
pnpm lint:prettier

# stylelint 格式化样式
pnpm lint:stylelint

提交代码： ​

bash
# 提交代码（提交前会自动执行 lint:lint-staged 命令）
pnpm commit

npm script 详解 ​

json
{
	"scripts": {
		// 本地运行(dev环境)
		"dev": "vite",
		// 本地运行(dev环境)
		"serve": "vite",
		// 构建打包(dev环境)
		"build:dev": "vue-tsc && vite build --mode development",
		// 构建打包(test环境)
		"build:test": "vue-tsc && vite build --mode test",
		// 构建打包(pro环境)
		"build:pro": "vue-tsc && vite build --mode production",
		// 检查项目 ts 类型
		"type:check": "vue-tsc --noEmit --skipLibCheck",
		// 本地环境预览构建后的 dist
		"preview": "npm run build:dev && vite preview",
		// 执行 eslint 校验
		"lint:eslint": "eslint --fix --ext .js,.ts,.vue ./src",
		// 执行 prettier 格式化
		"lint:prettier": "prettier --write \"src/**/*.{js,ts,json,tsx,css,less,scss,vue,html,md}\"",
		// 执行 stylelint 格式化
		"lint:stylelint": "stylelint --cache --fix \"**/*.{vue,less,postcss,css,scss}\" --cache --cache-location node_modules/.cache/stylelint/",
		// 执行 lint-staged.config.js 文件下的命令
		"lint:lint-staged": "lint-staged",
		// 初始化 husky 配置
		"prepare": "husky install",
		// 自动更新版本
		"release": "standard-version",
		// 提交代码(可自定义配置执行命令)
		"commit": "git add -A && czg && git push"
	}
}

MIT License.

Copyright © 2022 Geeker-Admin