m-mall-admin

后台管理界面Demo用户名/密码：admin/123456

项目说明：

• 基于 Node.js、MongoDB、Redis 开发的系统
• 基于 Express 提供 RESTful API
• 基于 apidoc 提供接口文档
• 基于 Angular.js、Ionic、Webpack 构建前端
• 基于 ECMAScript 6 编码风格

目录结构：

m-mall-admin/
  |-bin/                      # 启动文件
     |- wwww
  |-common/                   # 公共文件
     |- ...
  |-controllers/              # 控制器
     |- ...
  |-db/                       # 数据库配置
     |- ...
  |-logs/                     # 日志文件
     |- ...
  |-middlewares/              # 中间件
     |- ...
  |-models/                   # 模型
     |- ...
  |-proxy/                    # 代理
     |- ...
  |-public/                   # 静态资源文件
     |- ...
  |-routes/                   # 路由文件
     |- ...
  |-test/                     # 测试文件
     |- ...
  |-views/                    # 视图文件
     |- ...
  |-apidoc.json               # 接口文档配置
  |-app.js                    # 入口文件
  |-config.js                 # 配置文件--默认是docker容器版本
  |-config-local.js           # 配置文件--本地运行服务的版本，如果需要重命名替换config.js
  |-...

安装部署：

克隆文件：

git clone git@github.com:skyvow/m-mall-admin.git
cd m-mall-admin

环境准备(for mac)：

mongodb

安装：brew install mongodb 启动：

• 后台服务：mongod --config /usr/local/etc/mongod.conf（我添加了alias手动启动： start-mongod）
• 客户端：mongo 配置/usr/local/etc/mongod.conf
• 日志：/usr/local/var/log/mongodb/mongo.log
• 数据库位置：/usr/local/var/mongodb
• 默认绑定本地127.0.0.1（其他机器无法连接） 开机启动：(brew services list) brew services start mongodb

redis

安装：brew install redis 启动：

• 后台服务：redis-server /usr/local/etc/redis.conf（我添加了alias手动启动： start-redis-server，并配置启动参数，指定日志 --logfile "redis.log" --loglevel verbose ）
• 客户端：redis-cli 配置/usr/local/etc/mongod.conf
• 日志：logfile配置默认是"",即/dev/null，mac中用brew安装，logfile="redis.log"，则表示/usr/local/var/db/redis/redis.log。（也可以加入路径）
• 数据库位置：/usr/local/var/db/redis/
• 默认绑定本地127.0.0.1（其他机器无法连接） 开机启动：(brew services list) brew services start redis

注意：conda按照的redis与他冲突了(查看redis-server的位置)，conda uninstall redis

nvm&&node

nvm来管理node版本，brew install nvm

• nvm install node 安装最新版 Node
• nvm ls 查看当前的node版本
• nvm install 6.9 按照6.9.x的最新版本

** 这个小程序系统用了node 6.9.5，使用node 7会报buffer相关api的错误。**

后端服务：

1. 安装 `Node.js[必须]` `MongoDB[必须]` `Redis[必须]`
2. 启动 MongoDB 和 Redis
3. 进入根目录下执行 `npm install` 安装项目所需依赖包
3. 如果本地执行，修改`config.js`（使用`config-local.js` 替换）执行 `npm start` 启动服务
4. 打开前端小程序，api可以使用

前端服务：

1. 首次启动项目未找到 build 文件
2. 进入 public 目录下执行 `npm install` 安装项目所需依赖包
3. 执行 `npm run build` 编译前端页面相关文件
4. 编译成功后生成 build 文件，位于 public 目录下
5. 打开浏览器访问 `http://localhost:3000`

其他命令:

# 生成 API 接口文档
1. npm run apidoc
2. 打开浏览器访问 `http://localhost:3000/apidoc`

# 跑测试用例
npm test

Docker环境部署

安装nginx && ssl support

直接用hyperapp安装（也可自行安装，注意开启VPS的80和445端口）:

• nginx-proxy：一个第三方镜像（jwilder/nginx-proxy），自动化配置nginx安装域名转发.
• Nginx SSL Support：快速支持https（使用letsencrypt证书）

查看&&修改配置文件

docker相关的配置文件：

• Dockerfile：生成web镜像，是我们nodejs的项目镜像的构建编译，如果构建成功，一般不用修改。
• docker-compose.yml：项目编排文件，启动了redis，mongo。同时设置了域名的转发和ssl证书。按实际情况修改。
• Dockerfile-ubuntu：一个基于ubuntu的版本，生成镜像比较大，仅仅备份一下。

运行

• 启动安装好的nginx-proxy && Nginx-SSL-Support
• 在根目录下运行docker-compose up -d（如果需要前台运行，去掉-d参数,，关注日志输出）
• 可选：如果需要单独生成nodejs的镜像，运行docker build -t muzhi1991/m-mall-admin .（注意最后的点）
• 可选：如果修改代码后运行程序，docker-compose up --build -d回强制构建镜像

注意：使用docker images可能输出很多none的镜像，这是使用docker build/docker-compose build后可能回保留之前的旧镜像，可以使用命令docker rmi $(docker images -qa -f 'dangling=true') 批量删除

Debug

如果需要debug，主要有两种方式

本地调试

线下开发的Debug：在vscode中运行debug（参考下图），

相关配置已经写入.vscode/launch.json和.vscode/tasks.josn中（sourcemap文件会生成在本地.compiled/文件夹中）。

远程调试

在线上容器Docker中Debug：使用Nodejs的远程调试功能，

1. 请在docker-compose.yml中打开command: [npm, run, debug]
2. 运行docker-compose restart webapp，重启启动web应用
3. 打开容器日志docker logs --tail 30 -f m-mall-admin_webapp_1
4. 根据日志提示在本地chrome浏览器中打开连接，注意把127.0.0.1换成你的开发机ip

配置在package.json的debug命令中。一个问题：这里没有生成sourcemap。

贡献

有任何意见或建议都欢迎提 issue

License

MIT