readme.md

cslds-software-csu

中南大学软件学院 学业服务与发展中心 代码仓库

运行环境

Node.js >= 7.6.0 或使用 --harmony

部署说明

初始化

在 Terminal 中执行 npm run setup, 按提示完成初始化.

$ npm install
$ npm run setup

Setup Script
? Server port                                       # 服务器运行端口
? Server session-key                                # session-key
? MySQL server address                              # 数据库地址
? MySQL server port                                 # 数据库端口
? MySQL username                                    # 数据库用户名
? MySQL password                                    # 数据库密码
? Application database                              # 数据库名
? Initial admin account                             # 初始管理员账号
? Initial admin password                            # 初始管理员密码
? Build now?                                        # 是否立即执行构建
? Force sync model with database now?               # 是否立即强制与数据库同步模型, 会清空现有数据
? Start server now?                                 # 是否立即开始运行

配置文件会保存到 /backend/config/config.json, 可以使用文本编辑器进行编辑.

启动服务器

在 Terminal 中执行以下命令:

$ npm start

服务器便会开始运行, 访问 http://localhost:设置的端口号 即可看到页面.

指令列表

$ npm run dev               # 启动前端开发环境
$ npm run build             # 构建前端
$ npm run lint              # 执行 ESLint 检查
$ npm start                 # 启动服务器
$ npm run setup             # 执行初始化脚本
$ npm run sync              # 强制与数据库同步模型, 会清空现有数据

提交说明

提交前请进行以下工作:

1. 执行 ESLint 的代码检查工作(通过 npm run lint 完成), /frontent 和 /backend 都配置了各自的 ESLint 检查文件, 确保修复所有的 Error 和除了 no-unused-variable 以外的 Warning.
2. 配置 .gitignore 文件, 检查以下文件是否在提交列表中:

• 个体差异性开发环境, 包括但不限于 .idea, .vscode, .DS_STORE 等
• node_modules 等需要重新安装的文件
• npm_debug.log, yarn_error.log 等调试文件
• /backend/config/config.json 等配置文件
• /frontend/dist, /backend/public 等已构建后的文件

3. 对所有文件进行一次 diff 检查, 确保提交的代码正确.

License

MIT