# server api

**Repository Path**: gongzixi/server-api

## Basic Information

- **Project Name**: server api
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2020-04-10
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# 一、概述

## 下载项目

git clone https://gitee.com/gongzixi/server-api



## 安装

yarn install


## 运行开发环境

yarn run dev


## 打包测试

yarn run buildTest

## 打包生产

yarn run build

## pm2启动项目

#### 1. cd dist
#### 2. pm2 start index.js --watch --name [your-project-name]


# 二、配置使用

## 1、目录结构介绍：

dist  // 编译后的可执行文件均在此处  
src  // 源码文件目录  
 |--config // 配置文件夹，后端通讯、跨域、日志、session各个配置项均在此处  
 |--libs  // 公共库文件夹，所有公共方法和第三库均放在此处  
 |--routers  // 路由文件夹  
 |--app.js  // express启动文件  
 |--env.js  // 环境变量加载方法文件  
 |--index.js  // 程序入口文件  
.env // 开发环境变量配置文件  
.env.production // 生产环境变量配置文件  
.env.test // 测试环境变量配置文件 
.babelrc  // babel配置文件  
.gitignore  // git忽略文件  
package.json  // npm包文件  
README.md  



## 2、.env 环境变量配置

1、环境变量集中配置在.env 文件中，如下：<br />

NODE_ENV = 'debug'

\# Application  
APP_NAME='Easy Front Express API'  
APP_VERSION='1.0.0'  
APP_PORT='8080'  
APP_HOST='0.0.0.0'  
APP_COOKIE_KEY = 'express-front-express-api'  

\# Log  
LOG_DIR = ''  
LOG_LEVEL='debug'  


2、所有配置在.env 的环境变量，均可在其他代码中加上 process.env.直接使用，如下：<br />

 process.env.APP_NAME

3、环境变量一共有个3个：
* .env 本地
* .env.production 生产
* .env.test 测试