From a8322a62e7161551506e28b2a269565e2e6d989b Mon Sep 17 00:00:00 2001 From: Bosn Date: Tue, 15 May 2018 14:26:12 +0800 Subject: [PATCH] update readme --- README.md | 57 +++++++++++++++++++++---------------------------------- 1 file changed, 22 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index a4b6832..aa798e3 100644 --- a/README.md +++ b/README.md @@ -1,98 +1,86 @@ -# RAP2-DELOS CE version (back-end data API server) +# RAP2-DELOS 开源社区版本 (后端API服务器) [![Build Status](https://travis-ci.org/thx/rap2-delos.svg?branch=master)](https://travis-ci.org/thx/rap2-delos) - -RAP2 is a new project based on [RAP1](https://github.com/thx/RAP). It has two components: RAP2是在RAP1基础上重做的新项目,它包含两个组件(对应两个Github Repository)。 -* rap2-delos: back-end data API server based on Koa + MySQL [link](http://github.com/thx/rap2-delos) -* rap2-dolores: front-end static build based on React [link](http://github.com/thx/rap2-dolores) - - * rap2-delos: 后端数据API服务器,基于Koa + MySQL[link](http://github.com/thx/rap2-delos) * rap2-dolores: 前端静态资源,基于React [link](http://github.com/thx/rap2-dolores) ### Resources * [Official Site 官网: rap2.taobao.org](http://rap2.taobao.org) -* DingDing Group ID 钉钉群: 11789704 +* 钉钉群ID: 11789704 * [热心网友提供的部署文档,供参考](https://github.com/thx/rap2-delos/issues/119) -## Deployment 部署 +## 部署 -### enviaronment requirements 环境要求 +### 环境要求 * Node.js 8.9.4+ * MySQL 5.7+ * Redis 4.0+ -### development 开发模式 +### 开发模式 -#### install mysql and redis server #### 安装MySQL和Redis服务器 请自行查找搭建方法,mysql/redis配置在config.*.ts文件中,在不修改任何配置的情况下, redis会通过默认端口 + 本机即可正常访问,确保redis-server打开即可。 -#### start redis-server + #### 启动redis-server + ```sh redis-server ``` 后台执行可以使用nohup或pm2,这里推荐使用pm2,下面命令会安装pm2,并通过pm2来启动redis缓存服务 + ```bash npm install -g pm2 npm run start:redis ``` -#### create database at first #### 先创建创建数据库 ```bash mysql -e 'CREATE DATABASE IF NOT EXISTS RAP2_DELOS_APP DEFAULT CHARSET utf8 COLLATE utf8_general_ci' ``` -#### initialize #### 初始化 + ```bash npm install ``` -confirm configurations in /config/config.dev.js (used in development mode) -确认/config/config.dev.js中的配置(.dev.js后缀表示用于开发模式) +confirm configurations in /config/config.dev.js (used in development mode),确认/config/config.dev.js中的配置(.dev.js后缀表示用于开发模式)。 -#### Install and compile TypeScript code #### 安装 && TypeScript编译 + ```bash npm install -g typescript npm run build ``` -#### initialize database tables #### 初始化数据库表 + ```bash npm run create-db ``` -#### execute mocha test cases & js code check + #### 执行mocha测试用例和js代码规范检查 ```bash npm run check ``` -#### start server in development mode, watch & restart automatically #### 启动开发模式的服务器 监视并在发生代码变更时自动重启 ```bash npm run dev ``` -### production 生产模式 +### 生产模式 ```sh - -# 1. change server config in /config/config.prod.js # 1. 修改/config/config.prod.js中的服务器配置 - -# 2. start server in production mode # 2. 启动生产模式服务器 npm start @@ -118,22 +106,21 @@ npm start ## Author - -* Owner: Alimama FE Team -* Author: - * Before v2.3: all by [@Nuysoft](https://github.com/nuysoft/), creator of [mockjs](mockjs.com). - * v2.4+ / CE version: [Bosn](http://github.com/bosn/)(creator of [RAP1](https://github.com/thx/RAP)) [Nuysoft](https://github.com/nuysoft/) - * We are looking for more and more contributors :) - +* 版权: 阿里妈妈前端团队 +* 作者: + * RAP2 2017/10前版本作者为[墨智(@Nuysoft)](https://github.com/nuysoft/), [mockjs](mockjs.com)的作者。 + * 2017/10之后版本开发者 + * [霍雍(Bosn)](http://github.com/bosn/)([RAP1](http://github.com/thx/RAP)作者,RAP最早的创始人。) + * [承虎(alvarto)](http://github.com/alvarto/)。 ### Tech Arch -* Front-end (rap2-dolores) +* 前端架构(rap2-dolores) * React / Redux / Saga / Router * Mock.js * SASS / Bootstrap 4 beta * server: nginx -* Back-end (rap2-delos) +* 后端架构(rap2-delos) * Koa * Sequelize * MySQL