援助武汉 RESTful API

基于 Koa、TypeScript 和 TypeORM 的 Node.js 后端项目脚手架

主要特性

1. LeanCloud 手机短信验证码登录
2. 角色管理
3. 用户管理
4. 文件管理
5. 物资需求管理
6. 物流管理
7. 酒店管理
8. 供应商管理
9. 义诊管理
10. 捐款接收方管理
11. 疫情数据查询

环境变量

名称	用途
APP_SECRET	加密密码和令牌
DATABASE_URL	PostgreSQL 连接字符串
LEANCLOUD_API_HOST	LeanCloud API 主机地址
LEANCLOUD_APP_ID	LeanCloud 应用 ID
LEANCLOUD_APP_KEY	LeanCloud 应用 Key
AWS_S3_END_POINT	AWS S3 端点地址
AWS_S3_BUCKET	AWS S3 存储桶名称
AWS_S3_ACCESS_KEY_ID	AWS S3 访问密钥 ID
AWS_S3_SECRET_ACCESS_KEY	AWS S3 访问密钥
AWS_S3_PUBLIC_HOST	AWS S3 公共主机

本地开发

1. 安装 Node.js

2. git clone https://github.com/wuhan2020/rest-api.git

3. 生成 GitHub 个人访问令牌，并以 GH_PAT 为变量名存入项目根目录的 .env.personal.local 文件

4. 在本项目文件夹执行安装命令后启动

npm i pnpm -g
pnpm i
pnpm dev

5. 也可在 VS Code 中按 F5，以调试模式启动

部署

启动生产环境

npm start

数据迁移

pnpm upgrade:pro

Docker

pnpm pack-image
pnpm container

发布

部署应用

git checkout master
git tag v2.0.0  # 版本号来自 ./package.json
git push origin master --tags

发布类型包

git checkout master
git tag type-v2.0.0  # 版本号来自 ./type/package.json
git push origin master --tags

测试数据

• 地址：https://vsw505fxbitp.leanapp.cn

• 手机号：19949484787

• 短信验证码：003754

特别感谢

freeCodeCamp 成都社区捐助 ￥ 900 用于购买 LeanCloud 商业版一个月，以支撑每日超 3 万次的 API 访问。