diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..5a743161c38b917848296cfdf0e16404f3c76565 --- /dev/null +++ b/README.en.md @@ -0,0 +1,128 @@ +# Xingang Admin + +## Project Introduction +Xingang Admin is a Vue-based backend management system that provides rich functional modules and components, suitable for quickly building enterprise-level backend applications. + +## Key Features +- Comprehensive permission management +- Multiple commonly used business modules (orders, products, users, marketing, etc.) +- Rich UI component library +- Multi-language support +- Integrated chart display +- Complete development documentation + +## Directory Structure +```bash +admin/ +├── .babelrc +├── .env +├── .env.dev +├── .env.production +├── .eslintignore +├── .eslintrc.js +├── .postcssrc.js +├── .prettierignore +├── .prettierrc.js +├── .travis.yml +├── CHANGELOG.md +├── LICENSE +├── README.md +├── babel.config.js +├── cypress.json +├── package-lock.json +├── package.json +├── public +│ ├── favicon.ico +│ ├── image +│ ├── index.html +│ └── manifest.json +├── src +│ ├── App.vue +│ ├── api +│ ├── assets +│ ├── components +│ ├── config +│ ├── directive +│ ├── filters +│ ├── i18n +│ ├── layout +│ ├── libs +│ ├── main.js +│ ├── pages +│ ├── plugin +│ ├── router +│ ├── store +│ ├── styles +│ └── utils +└── vue.config.js +``` + +## Development Standards +### Naming Conventions +- Component names use PascalCase +- Page names use PascalCase +- Route names use kebab-case +- Variable names use camelCase + +### File Management Conventions +- All business components are stored in the `src/components` directory +- Page components are stored in the `src/pages` directory +- Route configurations are stored in the `src/router` directory +- Style files are centrally managed in the `src/styles` directory + +## Development Environment Setup +### Install Dependencies +```bash +npm install +``` + +### Start the Project +```bash +npm run dev +``` + +## Production Environment Setup +### Build the Project +```bash +npm run build +``` + +### Configure Request Domain +Set the API request address in `src/config/index.js` + +## Module Overview +- **account**: Account management module +- **agent**: Agent management module +- **app**: Application management module +- **cms**: Content management module +- **crud**: Basic CRUD (Create, Read, Update, Delete) module +- **finance**: Financial management module +- **kefu**: Customer service management module +- **marketing**: Marketing campaign module +- **order**: Order management module +- **product**: Product management module +- **setting**: System settings module +- **statistic**: Statistics and reporting module +- **system**: System management module +- **user**: User management module + +## Usage Instructions +For detailed usage instructions, please refer to the project documentation and code examples. + +## Version Updates +For version update records, please check `CHANGELOG.md` + +## Technology Stack +- Vue.js +- Vue Router +- Vuex +- Axios +- Element UI +- Sass +- ECharts + +## Contribution Guidelines +Code contributions are welcome. Please read the development standards first and submit a PR. + +## License +This project is licensed under the MIT License. Please refer to the `LICENSE` file for details. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..ee2f5762a1e715a68a33c6f3dca7fad14e2e198c --- /dev/null +++ b/README.md @@ -0,0 +1,128 @@ +# Xingang Admin + +## 项目介绍 +Xingang Admin 是一个基于 Vue 的后台管理系统,提供了丰富的功能模块和组件,适用于快速搭建企业级后台应用。 + +## 功能特性 +- 完善的权限管理 +- 多种常用业务模块(订单、商品、用户、营销等) +- 丰富的 UI 组件库 +- 支持多语言 +- 集成图表展示 +- 提供完善的开发文档 + +## 目录结构 +```bash +admin/ +├── .babelrc +├── .env +├── .env.dev +├── .env.production +├── .eslintignore +├── .eslintrc.js +├── .postcssrc.js +├── .prettierignore +├── .prettierrc.js +├── .travis.yml +├── CHANGELOG.md +├── LICENSE +├── README.md +├── babel.config.js +├── cypress.json +├── package-lock.json +├── package.json +├── public +│ ├── favicon.ico +│ ├── image +│ ├── index.html +│ └── manifest.json +├── src +│ ├── App.vue +│ ├── api +│ ├── assets +│ ├── components +│ ├── config +│ ├── directive +│ ├── filters +│ ├── i18n +│ ├── layout +│ ├── libs +│ ├── main.js +│ ├── pages +│ ├── plugin +│ ├── router +│ ├── store +│ ├── styles +│ └── utils +└── vue.config.js +``` + +## 开发规范 +### 命名规范 +- 组件命名采用 PascalCase +- 页面命名采用 PascalCase +- 路由命名采用 kebab-case +- 变量命名采用 camelCase + +### 文件管理规范 +- 所有业务组件存放在 `src/components` 目录 +- 页面组件存放在 `src/pages` 目录 +- 路由配置存放在 `src/router` 目录 +- 样式文件统一管理在 `src/styles` 目录 + +## 开发环境配置 +### 安装依赖 +```bash +npm install +``` + +### 启动项目 +```bash +npm run dev +``` + +## 生产环境配置 +### 打包项目 +```bash +npm run build +``` + +### 配置请求域名 +在 `src/config/index.js` 中配置 API 请求地址 + +## 模块介绍 +- **account**: 账户管理模块 +- **agent**: 代理商管理模块 +- **app**: 应用管理模块 +- **cms**: 内容管理模块 +- **crud**: 基础增删改查模块 +- **finance**: 财务管理模块 +- **kefu**: 客服管理模块 +- **marketing**: 营销活动模块 +- **order**: 订单管理模块 +- **product**: 商品管理模块 +- **setting**: 系统设置模块 +- **statistic**: 统计报表模块 +- **system**: 系统管理模块 +- **user**: 用户管理模块 + +## 使用说明 +详细使用说明请参考项目文档和代码示例 + +## 版本更新 +版本更新记录请查看 `CHANGELOG.md` + +## 技术选型 +- Vue.js +- Vue Router +- Vuex +- Axios +- Element UI +- Sass +- ECharts + +## 贡献指南 +欢迎贡献代码,请先阅读开发规范并提交 PR + +## 许可证 +本项目采用 MIT 许可证,请查看 `LICENSE` 文件获取详情 \ No newline at end of file