diff --git a/README.md b/README.md index b1bd70d..9827190 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,24 @@ # Business Center Vite -This template should help get you started developing with Vue 3 in Vite. +> 【注意】当前项目尚处于早期开发阶段，不建议生产使用。 -## Recommended IDE Setup +business-center-vite 是一个开源免费，含前后端的后台管理模板 -[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur). +## 项目结构 -## Type Support for `.vue` Imports in TS +项目在主仓库维护，子仓库仅定期同步代码，如您只需要前端/后端模板，可以使用子仓库代码。 -TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types. - -## Customize configuration - -See [Vite Configuration Reference](https://vite.dev/config/). - -## Project Setup - -```sh -npm install +``` +business-center-vite (主仓库 business-center-vite) + ├─ frontend ---------- 项目前端源码 (定期同步代码至子仓库: business-center-frontend) + │ ├─ ... + │ └─ README.md ----- 前端自述文件 + ├─ backend ----------- 项目后端源码 (定期同步代码至子仓库: business-center-backend) + │ ├─ ... + │ └─ README.md ----- 后端自述文件 + └─ README.md --------- 自述文件 ``` -### Compile and Hot-Reload for Development +## 贡献 -```sh -npm run dev -``` - -### Type-Check, Compile and Minify for Production - -```sh -npm run build -``` - -### Run Unit Tests with [Vitest](https://vitest.dev/) - -```sh -npm run test:unit -``` - -### Lint with [ESLint](https://eslint.org/) - -```sh -npm run lint -``` +请在主仓库进行 issue 或 pr 提交，子仓库仅作同步。 diff --git a/.editorconfig b/frontend/.editorconfig similarity index 100% rename from .editorconfig rename to frontend/.editorconfig diff --git a/.gitattributes b/frontend/.gitattributes similarity index 100% rename from .gitattributes rename to frontend/.gitattributes diff --git a/.gitignore b/frontend/.gitignore similarity index 100% rename from .gitignore rename to frontend/.gitignore diff --git a/.prettierrc.json b/frontend/.prettierrc.json similarity index 100% rename from .prettierrc.json rename to frontend/.prettierrc.json diff --git a/.vscode/extensions.json b/frontend/.vscode/extensions.json similarity index 100% rename from .vscode/extensions.json rename to frontend/.vscode/extensions.json diff --git a/frontend/README.md b/frontend/README.md new file mode 100644 index 0000000..b1bd70d --- /dev/null +++ b/frontend/README.md @@ -0,0 +1,45 @@ +# Business Center Vite + +This template should help get you started developing with Vue 3 in Vite. + +## Recommended IDE Setup + +[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur). + +## Type Support for `.vue` Imports in TS + +TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types. + +## Customize configuration + +See [Vite Configuration Reference](https://vite.dev/config/). + +## Project Setup + +```sh +npm install +``` + +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` + +### Type-Check, Compile and Minify for Production + +```sh +npm run build +``` + +### Run Unit Tests with [Vitest](https://vitest.dev/) + +```sh +npm run test:unit +``` + +### Lint with [ESLint](https://eslint.org/) + +```sh +npm run lint +``` diff --git a/env.d.ts b/frontend/env.d.ts similarity index 100% rename from env.d.ts rename to frontend/env.d.ts diff --git a/eslint.config.ts b/frontend/eslint.config.ts similarity index 100% rename from eslint.config.ts rename to frontend/eslint.config.ts diff --git a/index.html b/frontend/index.html similarity index 100% rename from index.html rename to frontend/index.html diff --git a/package.json b/frontend/package.json similarity index 100% rename from package.json rename to frontend/package.json diff --git a/public/favicon.ico b/frontend/public/favicon.ico similarity index 100% rename from public/favicon.ico rename to frontend/public/favicon.ico diff --git a/src/App.vue b/frontend/src/App.vue similarity index 100% rename from src/App.vue rename to frontend/src/App.vue diff --git a/src/assets/base.css b/frontend/src/assets/base.css similarity index 100% rename from src/assets/base.css rename to frontend/src/assets/base.css diff --git a/src/assets/logo.svg b/frontend/src/assets/logo.svg similarity index 100% rename from src/assets/logo.svg rename to frontend/src/assets/logo.svg diff --git a/src/assets/main.css b/frontend/src/assets/main.css similarity index 100% rename from src/assets/main.css rename to frontend/src/assets/main.css diff --git a/src/components/HelloWorld.vue b/frontend/src/components/HelloWorld.vue similarity index 100% rename from src/components/HelloWorld.vue rename to frontend/src/components/HelloWorld.vue diff --git a/src/components/TheWelcome.vue b/frontend/src/components/TheWelcome.vue similarity index 100% rename from src/components/TheWelcome.vue rename to frontend/src/components/TheWelcome.vue diff --git a/src/components/WelcomeItem.vue b/frontend/src/components/WelcomeItem.vue similarity index 100% rename from src/components/WelcomeItem.vue rename to frontend/src/components/WelcomeItem.vue diff --git a/src/components/__tests__/HelloWorld.spec.ts b/frontend/src/components/__tests__/HelloWorld.spec.ts similarity index 100% rename from src/components/__tests__/HelloWorld.spec.ts rename to frontend/src/components/__tests__/HelloWorld.spec.ts diff --git a/src/components/icons/IconCommunity.vue b/frontend/src/components/icons/IconCommunity.vue similarity index 100% rename from src/components/icons/IconCommunity.vue rename to frontend/src/components/icons/IconCommunity.vue diff --git a/src/components/icons/IconDocumentation.vue b/frontend/src/components/icons/IconDocumentation.vue similarity index 100% rename from src/components/icons/IconDocumentation.vue rename to frontend/src/components/icons/IconDocumentation.vue diff --git a/src/components/icons/IconEcosystem.vue b/frontend/src/components/icons/IconEcosystem.vue similarity index 100% rename from src/components/icons/IconEcosystem.vue rename to frontend/src/components/icons/IconEcosystem.vue diff --git a/src/components/icons/IconSupport.vue b/frontend/src/components/icons/IconSupport.vue similarity index 100% rename from src/components/icons/IconSupport.vue rename to frontend/src/components/icons/IconSupport.vue diff --git a/src/components/icons/IconTooling.vue b/frontend/src/components/icons/IconTooling.vue similarity index 100% rename from src/components/icons/IconTooling.vue rename to frontend/src/components/icons/IconTooling.vue diff --git a/src/main.ts b/frontend/src/main.ts similarity index 100% rename from src/main.ts rename to frontend/src/main.ts diff --git a/src/router/index.ts b/frontend/src/router/index.ts similarity index 100% rename from src/router/index.ts rename to frontend/src/router/index.ts diff --git a/src/stores/counter.ts b/frontend/src/stores/counter.ts similarity index 100% rename from src/stores/counter.ts rename to frontend/src/stores/counter.ts diff --git a/src/views/AboutView.vue b/frontend/src/views/AboutView.vue similarity index 100% rename from src/views/AboutView.vue rename to frontend/src/views/AboutView.vue diff --git a/src/views/HomeView.vue b/frontend/src/views/HomeView.vue similarity index 100% rename from src/views/HomeView.vue rename to frontend/src/views/HomeView.vue diff --git a/tsconfig.app.json b/frontend/tsconfig.app.json similarity index 100% rename from tsconfig.app.json rename to frontend/tsconfig.app.json diff --git a/tsconfig.json b/frontend/tsconfig.json similarity index 100% rename from tsconfig.json rename to frontend/tsconfig.json diff --git a/tsconfig.node.json b/frontend/tsconfig.node.json similarity index 100% rename from tsconfig.node.json rename to frontend/tsconfig.node.json diff --git a/tsconfig.vitest.json b/frontend/tsconfig.vitest.json similarity index 100% rename from tsconfig.vitest.json rename to frontend/tsconfig.vitest.json diff --git a/vite.config.ts b/frontend/vite.config.ts similarity index 100% rename from vite.config.ts rename to frontend/vite.config.ts diff --git a/vitest.config.ts b/frontend/vitest.config.ts similarity index 100% rename from vitest.config.ts rename to frontend/vitest.config.ts