Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xiaoping6688/node-server-project
基于 node.js + express 技术栈，采用MVC结构设计、JWT + RESTful API、PM2服务监控的Node服务器端项目框架.
https://github.com/xiaoping6688/node-server-project
handlebars mysql node-framework node-jwt node-orm node-restful node-web-server nodejs-express pm2 rabbitmq thrift
Last synced: 12 days ago
JSON representation
基于 node.js + express 技术栈，采用MVC结构设计、JWT + RESTful API、PM2服务监控的Node服务器端项目框架.
- Host: GitHub
- URL: https://github.com/xiaoping6688/node-server-project
- Owner: xiaoping6688
- Created: 2017-02-15T03:53:31.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-04-21T09:00:21.000Z (over 5 years ago)
- Last Synced: 2024-10-31T10:51:38.700Z (19 days ago)
- Topics: handlebars, mysql, node-framework, node-jwt, node-orm, node-restful, node-web-server, nodejs-express, pm2, rabbitmq, thrift
- Language: JavaScript
- Homepage:
- Size: 9.65 MB
- Stars: 47
- Watchers: 6
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# node-server-project
> 基于 node.js + express 技术栈，采用MVC结构设计、JWT + RESTful API、PM2服务监控的Node Web项目框架。
技术栈
- node.js（>7.0，已原生支持绝大部分ES6/ES7语法）
- express（成熟稳定的Web框架）
- hbs（handlebars后端模版引擎，语法简洁高效、实现模版继承和内嵌功能等）
- RESTful（API架构风格，并提供统一的接口输出结构）
- JWT（Json Web Token 认证协议，用于页面和API的验证，包括token续期方案等）
- ORM（数据库对象关系映射）
- TEST（集成在线API文档生成和测试工具[Swagger-ui](https://github.com/swagger-api/swagger-ui)，public/swagger目录下）
- RabbitMQ & Thrift & 环信服务端 集成等
- PM2（Node服务自动部署和监控）
关于API接口文档管理及线上线下测试，推荐：[SosoApi](http://www.sosoapi.com/)
## Build Setup @see package.json#scripts
### Install dependencies, use cnpm:
npm install -g cnpm --registry=https://registry.npm.taobao.org
```
cnpm install
```
### Start server for development or production (pm2)
```
npm start
```
### Auto restarting server and reloading browsers for development
```
npm run live:client // 客户端源码变动实时监测
npm run live:server // 服务端源码变动实时监测
```
### For unit test, such as:
```
npm test ./test/api/login.js
```
### Debug node code
Please install 'npm install -g node-inspector' at first
```
npm run debug
```
### Check update for npm packages
Please install 'npm install npm-check-updates -g' at first
```
npm run update
```
### PM2 operations and deploy（基于Git）
First of all, please install node.js and git on the server and set $PATH env in ~/.bashrc
```
export NODE_HOME=/data/node-v7.7.4-linux-x64
export PATH=$NODE_HOME/bin:$PATH
```
Host key verification after you execute ssh-keygen on server, and set ssh-key to gitlab.
```
ssh-keyscan -t rsa yourGitServer >> ~/.ssh/known_hosts
```
For client ssh password-less logon
```
ssh-keygen -t rsa
ssh-copy-id -i ~/.ssh/id_rsa.pub [email protected]
```
then, use ·npm run setup:test· for the first time, other deployment use ·npm run deploy:test·
```
npm run setup:test // 测试环境远程部署（第一次安装）
npm run setup:simu // 仿真环境远程部署（第一次安装）
npm run setup:prod // 生产环境远程部署（第一次安装）
npm run deploy:test // 测试环境远程部署（后期更新）
npm run deploy:simu // 仿真环境远程部署（后期更新）
npm run deploy:prod // 生产环境远程部署（后期更新）
npm run stop
npm run reload
npm run list
npm run monit
npm run logs
```