You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
rap2-delos/README.md

92 lines
2.7 KiB
Markdown

7 years ago
# RAP2-DELOS CE version (back-end data API server)
7 years ago
7 years ago
[![Build Status](https://travis-ci.org/thx/rap2-delos.svg?branch=master)](https://travis-ci.org/thx/rap2-delos)
7 years ago
7 years ago
RAP2 is a new project based on [RAP1](https://github.com/thx/RAP). It has two components:
7 years ago
RAP2是在RAP1基础上重做的新项目它包含两个组件(对应两个Github Repository)。
7 years ago
7 years ago
* 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)
7 years ago
7 years ago
* rap2-delos: 后端数据API服务器基于Koa + MySQL[link](http://github.com/thx/rap2-delos)
* rap2-dolores: 前端静态资源基于React [link](http://github.com/thx/rap2-dolores)
7 years ago
### Resources
7 years ago
* [Official Site 官网: rap2.taobao.org](http://rap2.taobao.org)
* DingDing Group ID 钉钉群: 11789704
7 years ago
7 years ago
## Deployment 部署
7 years ago
### enviaronment requirements 环境要求
* Node.js 8.9.4+
* MySQL 5.7+
7 years ago
### development 开发模式
7 years ago
```sh
7 years ago
# create database 先创建数据库
7 years ago
mysql -e 'CREATE DATABASE IF NOT EXISTS RAP2_DELOS_APP DEFAULT CHARSET utf8 COLLATE utf8_general_ci'
7 years ago
# initialize 初始化
7 years ago
npm install
7 years ago
# confirm configurations in /config/config.dev.js (used in development mode)
# 确认/config/config.dev.js中的配置(.dev.js后缀表示用于开发模式)
7 years ago
# TypeScript compile TS编译
# Installing TypeScript Compiler Docs 安装TypeScript编译器文档: [https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html](https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html)
npm run build
7 years ago
7 years ago
# initialize database 初始化数据库
7 years ago
npm run create-db
# execute mocha test cases & js code check
7 years ago
# 执行mocha测试用例和js代码规范检查
7 years ago
npm run check
7 years ago
# start server in development mode, watch & restart automatically
# 启动开发模式的服务器 监视并在发生代码变更时自动重启
7 years ago
npm run dev
7 years ago
7 years ago
```
7 years ago
### production 生产模式
7 years ago
7 years ago
```sh
7 years ago
7 years ago
# 1. change server config in /config/config.prod.js
# 1. 修改/config/config.prod.js中的服务器配置
# 2. start server in production mode
# 2. 启动生产模式服务器
7 years ago
npm start
7 years ago
```
7 years ago
## 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 :)
### Tech Arch
* Front-end (rap2-dolores)
* React / Redux / Saga / Router
* Mock.js
* SASS / Bootstrap 4 beta
* server: nginx
* Back-end (rap2-delos)
* Koa
* Sequelize
* MySQL
* Server
* server: node