XanaduCompany 项目使用教程
1. 项目的目录结构及介绍
XanaduCompany 是一个企业门户网站管理系统,包括前台展示、后台管理、后端服务三个部分。项目的目录结构如下:
XanaduCompany/
├── admin/ # 后台管理前端目录
├── server/ # 后端服务目录
├── web/ # 前台门户展示前端目录
├── .gitignore # git忽略文件
├── Dockerfile # Docker构建文件
├── LICENSE # 项目许可证文件
├── README.md # 项目说明文件
├── docker-compose.yml # Docker组合配置文件
└── nginx.conf # Nginx配置文件
- admin: 后台管理前端项目,使用 Vue + ElementUI 构建。
- server: 后端服务项目,使用 Node.js、Koa、Sequelize 和 MySQL。
- web: 前台门户展示前端项目,同样使用 Vue + ElementUI 构建。
- .gitignore: 指定 Git 忽略的文件和目录。
- Dockerfile: 定义了如何构建 Docker 容器。
- LICENSE: 项目使用的开源许可证,本项目采用 MIT 许可证。
- README.md: 项目说明文件,介绍了项目的基本信息和如何使用。
- docker-compose.yml: 定义了 Docker 服务组合,包括前端、后端和 Nginx。
- nginx.conf: Nginx 配置文件,用于反向代理等配置。
2. 项目的启动文件介绍
项目的启动主要涉及前端和后端两个部分。
后端启动
后端项目位于 server
目录下。首先,在项目目录中运行以下命令安装依赖:
npm install
然后,可以使用以下命令启动服务:
npm run start # 本地启动
# 或者
npm run dev # 实时监听改动重启
如果需要全局安装 nodemon 以使用 npm run dev
命令,可以运行:
npm i nodemon -g
前端启动
前端项目分为前台展示 (web
) 和后台管理 (admin
) 两个部分,分别在不同的目录下。
前台展示启动
在前台展示项目的目录 web
下,运行以下命令安装依赖:
npm install
然后,使用以下命令启动前端服务:
npm run serve
后台管理启动
在后台管理项目的目录 admin
下,同样运行以下命令安装依赖:
npm install
然后,使用以下命令启动前端服务:
npm run serve
3. 项目的配置文件介绍
后端配置文件
后端配置文件主要位于 server/config
目录下。
- dbinfo.js: 数据库配置文件,包含数据库连接信息,如主机、用户名、密码等。
module.exports = {
database: 'xanadu',
username: 'root',
password: 'password',
host: 'localhost',
port: 3306
};
根据实际情况,需要修改 host
、username
和 password
等信息。
前端配置文件
前端配置文件主要位于各前端项目目录下的 .env
文件和 vue.config.js
文件。
- .env: 环境变量配置文件,包含 API 基础路径等。
VUE_APP_BASE_API = 'http://localhost:3000/api/v1'
- vue.config.js: Vue 项目配置文件,可以配置代理、打包路径等。
module.exports = {
configureWebpack: {
// 配置项
},
devServer: {
// 开发服务器配置
}
};
根据实际需要,修改 API 基础路径和其它配置信息。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考