erp-java/services/user-service/README.md

42 lines
694 B
Markdown

# ${svc_name}
## 服务简介
TODO: 描述服务功能
## 技术栈
- Spring Cloud Alibaba
- MyBatis-Plus
- Nacos / Sentinel
## 端口
TODO: 填写服务端口
## 依赖服务
- Nacos (配置中心)
- MySQL
- Redis
## 启动命令
```bash
# 本地开发
mvn spring-boot:run
# Docker部署
docker build -t ${svc_name} .
docker run -p 8080:8080 ${svc_name}
```
## API文档
启动后访问: http://localhost:8080/swagger-ui.html
## 环境变量
| 变量 | 说明 | 默认值 |
|------|------|--------|
| NACOS_HOST | Nacos地址 | localhost |
| NACOS_PORT | Nacos端口 | 8848 |
| DB_HOST | 数据库地址 | localhost |
| DB_PORT | 数据库端口 | 3306 |
## 维护者
ERP开发团队