# 项目说明

> 特别说明：源码、JDK、Redis等存放路径禁止包含中文、空格、特殊字符等

## 关联项目

| 项目 | 分支 | 分支（Coding） | 说明 |
| --- | --- | --- | --- |
| **前端** |  |  |  |
| jnpf-web-tenant | v5.0.x | v5.0.x-stable | 多租户前端项目(Vue2)源码 |
| jnpf-web-tenant-vue3 | v5.0.x | v5.0.x-stable | 多租户前端项目(Vue3)源码 |

## 环境要求

> 官方建议： JDK版本不低于 `1.8.0_281`版本，可使用`OpenJDK 8`、`Alibaba Dragonwell 8`、`BiShengJDK 8`

项目  | 推荐版本                              | 说明
-----|-----------------------------------| -------------
JDK  | 默认使用JDK 21，兼容JDK 8/11、JDK17            | JAVA环境依赖(需配置环境变量)
Maven  | 3.6.3                             | 项目构建(需配置环境变量)
Redis  | 3.2.100(Windows)/6.0.x(Linux,Mac) |
MySQL  | 5.7.x+                            | 数据库任选一(默认)
SQLServer  | 2012+                             | 数据库任选一
Oracle  | 11g+                              | 数据库任选一
PostgreSQL  | 12+                               | 数据库任选一
达梦数据库 | DM8                               | 数据库任选一
人大金库 | KingbaseES V8 R6                  | 数据库任选一

## 使用说明
#### 私服配置(如有需要)
- 修改`maven下conf/settings.xml`文件
- 在`<servers></servers>`中添加

``` xml
<server>
    <id>maven-releases</id>
    <username>jnpf</username>
    <password>R1OUrwC9nn0rnr5g</password>
</server>
<server>
    <id>maven-snapshots</id>
    <username>jnpf</username>
    <password>R1OUrwC9nn0rnr5g</password>
</server>
```

在`<mirrors></mirrors>`中添加

``` xml
<mirror>
  <id>maven-releases</id>
  <mirrorOf>*</mirrorOf>
  <name>maven-releases</name>
  <url>https://repository.jnpfsoft.com/repository/maven-public/</url>
</mirror>

```
#### 配置
- 打开`src/main/resources`中的`application.yml`

> 环境变量
> - dev  开发环境
> -  teset  测试环境
> -  preview 预发布环境
> -  pro 生产环境

``` yml
  #环境 dev|test|pro|preview
  profiles:
  active: dev
```
- 打开`application-x.yml`(`x`表示环境变量),需配置以下
    - 服务端口(`port`)
    - 数据库连接
    - Redis
    - 静态资源

#### 启动项目
- 找到`src/main/java/jnpf/JnpfTenantApplication.java`，右击运行即可。