README.md

🍎 Our Home ❤️

Setup

无论是开发还是部署，都要先安装 Nodejs (v7.6.0 以上版本)和 MongoDB。

开发配置

# 假定已安装 Nodejs v7.6.0+ 和 MongoDB

# clone 项目并设置
$ git clone [email protected]:CSU-Apple-Lab/Home.git
$ npm i
$ cd Home/init
$ cp config.example.js config.js
$ vim config.js                              # 编辑配置文件，包含监听端口，MongoDB 端口及其用户验证等
$ cd ..

# 进行单元测试
$ npm test

# 设置环境变量
$ export NODE_ENV=development

# 运行
$ node ./bin/www

部署配置

# 假定已安装 Nodejs v7.6.0+ 和 MongoDB

# 安装 pm2
$ sudo npm i -g pm2

# clone 项目并设置
$ git clone https://github.com/CSU-Apple-Lab/Home.git
$ npm i
$ cd Home/init
$ cp config.example.js config.js
$ vim config.js                                     # 编辑配置文件，包含监听端口，MongoDB 端口及其用户验证等
$ cd ..

# 设置环境变量
$ export NODE_ENV=production

# 进行针对生产环境的单元测试
$ npm test

# 配置部署配置(可选)
$ vim labHome.yml

# 部署
$ pm2 start lab-home.yml

Work with Caddy

Koa 负责的内容

• 静态资源
• 动态请求
• ETag
• 错误日志

Caddy 负责的内容

• TLS (如果需要)
• gzip
• access 日志

TODO

前端

• 修复表单
• 修复路由

后端

• 解决 hbs 渲染问题
• 与前端对接 API 参数
• 添加日志模块
• 完善插入新数据前的查重与异常处理，将错误类型反馈到前端
• 添加渲染 400, 404, 500 等页面的中间件

Contributors

Powered by