BackEnd

使用

需安装 NodeJS LTS

git clone https://github.com/swsad-team/BackEnd.git
# 使用 npm 安装依赖
npm install
# 使用 yarn 安装依赖
yarn

脚本

• npm start

  启动服务器

• npm run start-dev

  启动测试服务器 （保存后自动重新运行）

• npm run debug

  调试

• npm run lint

  使用 eslint 进行代码风格检查

• npm run test

  进行测试

  测试时将会使用 mongodb-memory-server 作为数据库，在运行时可能会下载 mongodb 二进制文件。若下载出现问题请参考文档手动下载并指定路径

• npm run compile

  将源代码编译为 commonJS 模块

调试

• 使用 VSCode 进行调试

  按 F5 开始调试

开发

开发时请避免在 master 分支上进行操作。请先新建 dev 分支并以 Pull Request 的方式提交进主分支。

在运行前请先配置环境变量，在根目录新建 .env 文件。文件内容如下：

JWT_KEY=[YOUR JWT KEY]
MONGO_DB_URL=[YOUR MONGOD URL]
PORT=[SERVER PORT]

CI

master 分支会自动部署至生产服务器。

项目结构