richardweiu / rap2-delos

阿里妈妈前端团队出品的开源接口管理工具RAP第二代

RAP2-DELOS 开源社区版本 (后端API服务器)

RAP2 包含两个组件(对应两个Github Repository)。

• rap2-delos: 后端数据API服务器，基于Koa + MySQLlink
• rap2-dolores: 前端静态资源，基于React link

2019-09-27：更新的用户请注意按照下面指引安装 pandoc 以启用文档导出功能

Resources

• Official Site 官网: rap2.taobao.org
• 钉钉群ID: 11789704
• 热心网友提供的部署文档，供参考

部署

环境要求

• Node.js 8.9.4+
• MySQL 5.7+
• Redis 4.0+
• pandoc 2.73 (供文档生成使用)

开发模式

安装MySQL和Redis服务器

请自行查找搭建方法，mysql/redis配置在config.*.ts文件中，在不修改任何配置的情况下， redis会通过默认端口 + 本机即可正常访问，确保redis-server打开即可。

注意：修改 cofig 文件后需要重新 npm run build 才能生效

安装 pandoc

我们使用 pandoc 来生成 Rap 的离线文档，安装 Pandoc 最通用的办法是在 pandoc 的 release 页面下载对应平台的二进制文件安装即可。

其中 linux 版本最好放在/usr/local/bin/pandoc 让终端能直接找到，并执行 chmod +x /usr/local/bin/pandoc 给调用权限。

测试在命令行执行命令 pandoc -h 有响应即可。

启动redis-server

redis-server

后台执行可以使用nohup或pm2，这里推荐使用pm2，下面命令会安装pm2，并通过pm2来启动redis缓存服务

npm install -g pm2
npm run start:redis

先创建创建数据库

mysql -e 'CREATE DATABASE IF NOT EXISTS RAP2_DELOS_APP DEFAULT CHARSET utf8 COLLATE utf8_general_ci'

初始化

npm install

confirm configurations in /config/config.dev.js (used in development mode)，确认/config/config.dev.js中的配置(.dev.js后缀表示用于开发模式)。

安装 && TypeScript编译

npm install -g typescript
npm run build

初始化数据库表

npm run create-db

执行mocha测试用例和js代码规范检查

npm run check

启动开发模式的服务器 监视并在发生代码变更时自动重启

npm run dev

生产模式

# 1. 修改/config/config.prod.js中的服务器配置
# 2. 启动生产模式服务器
npm start

Dockerfile (本地源码通过docker运行）

# 1. 安装docker
# 2. 修改docker-compose.xml中的配置。默认使用mysql和redis的镜像。可修改为自己的配置
# 3. 通过源码运行。
        docker-compose up -d
# 4. 第一次运行需要手动初始化mysql数据库。分别执行以下命令：
        docker exec -it rap2-delos sh
    // 登录成功以后执行：
        node scripts/init
    // 执行完毕后退出
        exit
    // 如果仍然有问题，重新启动
        docker-compose down
    // 重新运行
        docker-compose up -d

Author

• 版权: 阿里妈妈前端团队
• 作者:
  • RAP2 2017/10前版本作者为墨智(@Nuysoft), mockjs的作者。
  • 2017/10之后版本开发者
    • 霍雍(Bosn)，RAP1作者，RAP最早的创始人。
    • 承虎(alvarto)
    • 池冰(bigfengyu)

Tech Arch

• 前端架构(rap2-dolores)
  • React / Redux / Saga / Router
  • Mock.js
  • SASS / Bootstrap 4 beta
  • server: nginx
• 后端架构(rap2-delos)
  • Koa
  • Sequelize
  • MySQL
  • Server
  • server: node