# Strelitzia

**Repository Path**: wiconwang/strelitzia

## Basic Information

- **Project Name**: Strelitzia
- **Description**: 基于SpringBoot编写的一个基础框架，写代码直接Down能省一两个小时初始项目。
- **Primary Language**: Java
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-08
- **Last Updated**: 2021-03-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

请使用 EasyCode 生成子模块

-----
## 一：安装步骤
### 1. 共用步骤
a. 请恢复数据库 SQL 请见databases目录   
b. 打开 /src/main/resources/ ：  
   > application.yml.example 复制成 application.yml 并配置 18行active的内容。开发环境是dev，线上环境是pro，根据需求配置     
   > application-dev.yml.example 复制成 application-dev.yml  并配置开发环境    
   > application-pro.yml.example 复制成 application-pro.yml  并配置线上环境


### 2. 研发环境部署方案：
c. IDEA直接在 StrelitziaApplication上点RUN就可以启动。

### 3. 生产环境部署方案：
c. 打包：
> mvn clean install -Dmaven.test.skip=true   

d. 启动：
> nohup java -jar strelitzia-0.0.1-SNAPSHOT.jar > /dev/null 2>&1 &

### 4. Docker部署方案（研发生产通用）
c. 依次执行以下Shell启动环境，或者将此命令编写为.sh文件，每次部署时执行一次。

```shell
#!/bin/bash
docker volume create --name maven-repo
docker run -it --rm --name maven -v "$(pwd)":/usr/src/app -v maven-repo:/usr/share/maven/ref -w /usr/src/app registry.cn-hangzhou.aliyuncs.com/acs/maven mvn clean install
docker run -idt --name=strelitzia_prod --restart=always  --net docker_webserver_prod-net -p 8089:8089 -v "$(pwd)":/wwwroot java:8 java -jar /wwwroot/target/strelitzia-0.0.1-SNAPSHOT.jar
```



## 二：接口文档
可以使用 http://你的项目地址和端口/api/swagger-ui.html 直接打开

### 其它
以下为部分参考：     
JS页面接口提交  
```js

//    $.ajax({
//        type: "POST",
//                contentType: "application/json;charset=UTF-8",
//                url: "/reg",
//                data: JSON.stringify(data.field),
//                dataType: 'json',
//                success: function(result) {
//            if(result.code == 0) {
//                layer.msg('注册成功！');
//            } else {
//                layer.msg(result.msg);
//            }
//        }
//    });

```
Java接口    
```java
//    @ApiOperation(value = "增加用户")
//    @RequestMapping(
//            value = "/add",
//            method = RequestMethod.POST)
//    @ResponseBody
//    public HttpResult create(Members members) {
//        RespPostModel response = new RespPostModel(request);
//
//        //获取管理员 token
//        UserTokenSubject token = TokenHelper.verifyToken(request.getHeader("Authorization"), response);
//        if(null == token){
//            return response;
//        }
//
//        members.setCreate_by(token.getId());
//        members.setCreate_time(System.currentTimeMillis());
//        Members data = membersService.insert(members);
//        System.out.println(data);
//        return HttpResult.ok();
//    }

```