vue-vben-admin icon indicating copy to clipboard operation
vue-vben-admin copied to clipboard

希望官方文档能讲解一下项目的目录结构,特别是src同级的文件

Open zphtown opened this issue 1 year ago • 1 comments

⚠️ IMPORTANT ⚠️ Please check the following list before proceeding. If you ignore this issue template, your issue will be directly closed.

  • [ ] Read the docs.
  • [ ] Make sure the code is up to date. (Some bugs have been fixed in the latest code)
  • [ ] This is a concrete bug. For Q&A open a GitHub Discussion or join our Discord Chat Server.

Describe the bug

希望官方文档能讲解一下项目的目录结构,特别是src同级的文件

Reproduction

希望官方文档能讲解一下项目的目录结构,特别是src同级的文件

System Info

  • Operating System:
  • Node version:
  • Package manager (npm/yarn/pnpm) and version:

zphtown avatar Jan 18 '24 09:01 zphtown

@zphtown 非官方分享一个:

vue-vben-admin/
├── .husky/(Git hooks 执行前运行脚本的工具,详看 husky 官网文档)
│   ├── _/
│   │   └── husky.sh
│   ├── commit-msg
│   ├── common.sh
│   └── pre-commit(提交之前,使用 lint-staged, 详看 package.json 的 "lint-staged")
├── .vscode/(IDE 配置)
│   ├── extensions.json(推荐项目配套扩展)
│   ├── launch.json(调试启动配置)
│   └── settings.json(IDE、扩展配置)
├── apps/(pnpm 工作空间,定义在 ./pnpm-workspace.yaml)
│   └── portal-view/(空)
│   └── test-server/(mock 文件上传服务,需要自行启动,参照 README.md、package.json)
├── internal/(pnpm 工作空间,定义在 ./pnpm-workspace.yaml)
│   ├── eslint-config/(ESLint 配置,即 @vben/eslint-config)
│   ├── stylelint-config/(Stylelint 配置,即 @vben/stylelint-config)
│   ├── ts-config/(Typescript 配置,即 @vben/ts-config)
│   └── vite-config/(Vite 配置,即 @vben/vite-config)
├── mock/(mock 方法定义)
├── packages/(pnpm 工作空间,定义在 ./pnpm-workspace.yaml)
│   ├── hooks/(一些 hooks 定义,即 @vben/hooks)
│   ├── types/(一些类型声明,即 @vben/types)
├── public/(静态资源)
├── src/(业务逻辑)
├── types/(全局类型声明)
├── .browserslistrc(配置 忽略部分)
├── .commitlintrc.cjs(配置 Commitlint)
├── .dockerignore(构建 Docker 镜像时忽略部分)
├── .editorconfig(IDE 编码风格和格式化规则)
├── .env(环境变量)
├── .env.analyze(--mode analyze 时候的环境变量)
├── .env.development(--mode development 时候的环境变量)
├── .env.docker(--mode docker 时候的环境变量)
├── .env.production(--mode production 时候的环境变量)
├── .env.test(--mode test 时候的环境变量)
├── .eslintignore(配置 ESLint 忽略部分)
├── .eslintrc.cjs(配置 ESLint)
├── .gitattributes(用于配置 Git 仓库中文件的属性和行为,例如文件的换行符、文件类型等)
├── .gitignore(用于指定 Git 仓库中需要忽略的文件或目录)
├── .gitpod.yml(用于配置 Gitpod 开发环境的文件)
├── .npmrc(npm 的配置文件,用于定义 npm 的行为,例如设置代理、镜像源等)
├── .prettierignore(配置 Prettier 忽略部分)
├── .prettierrc.cjs(配置 Prettier)
├── .stylelintignore(配置 Stylelint 忽略部分)
├── .stylelintrc.cjs(配置 Stylelint)
├── CHANGELOG.en_US.md(日志:英)
├── CHANGELOG.md(日志)
├── CHANGELOG.zh_CN.md(日志:中)
├── CNAME(用于配置自定义域名,通常用于 GitHub Pages 等静态网站托管服务。)
├── Dockerfile(用于定义 Docker 镜像的构建规则和依赖)
├── LICENSE(项目的开源许可证文件)
├── README.md(说明文档)
├── README.zh-CN.md(说明文档:中)
├── index.html(入口 HTML 文件)
├── nginx.conf(Nginx 服务器的配置文件)
├── package.json(项目配置文件)
├── pnpm-lock.yaml(锁定文件)
├── pnpm-workspace.yaml(工作区配置)
├── tsconfig.json(TypeScript 的配置文件)
├── turbo.json(用于定义 Vite 项目的一些特定配置)
├── uno.config.ts(Uno-CLI 的配置文件)
└── vite.config.ts(Vite 项目的配置文件)

xachary avatar Jan 19 '24 01:01 xachary

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days

anncwb avatar Apr 09 '24 01:04 anncwb