# mcore

**Repository Path**: kdisi_admin/mcore

## Basic Information

- **Project Name**: mcore
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-10-17
- **Last Updated**: 2026-10-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Core

Core 是一个 SaaS 后端核心模块，提供用户、租户、项目、应用、权限、数据管理和定时任务等基础服务。它由多个 Go 服务组成，可按业务需要配置和部署。

[Gitee 仓库](https://gitee.com/kdisi_admin/mcore) · [English](README.en.md)

## 功能概览

- **组织与权限**：用户、租户、项目、区域、角色、应用、模块、菜单和数据权限管理。
- **系统能力**：字典、通知、操作日志、登录日志、工单与反馈等管理功能。
- **数据服务**：提供可配置的数据查询接口，供业务页面和数据分析场景使用。
- **任务调度**：提供定时任务和延时任务能力，支持队列消息、SQL 和脚本等任务执行方式。
- **API 接入**：通过 HTTP API 网关统一提供接口，并按配置转发相关请求。

## 服务组成

| 服务 | 目录 | 主要职责 |
| --- | --- | --- |
| API 网关 | `service/apisvr` | HTTP API、接口路由与代理 |
| 系统管理 | `service/syssvr` | 用户、租户、项目、权限及系统管理能力 |
| 数据服务 | `service/datasvr` | 配置化数据查询与数据接口 |
| 定时任务执行器 | `service/timed/timedjobsvr` | 执行定时和延时任务 |
| 定时任务调度器 | `service/timed/timedschedulersvr` | 触发并调度定时任务 |

各服务的监听地址和外部依赖以对应配置文件为准。

## 代码结构

```text
service/
├── apisvr/                 # HTTP API 网关
├── syssvr/                 # 系统管理服务及 RPC 接口
├── datasvr/                # 数据服务
└── timed/
    ├── timedjobsvr/        # 定时任务执行器
    └── timedschedulersvr/  # 定时任务调度器
share/                      # 仓库内共享代码
doc/                        # 架构图、开发说明及方案文档
```

## 本地构建

### 环境要求

- Go **1.27.3**（见 `go.mod`）
- 仓库所需 Go 模块依赖；其中部分依赖可能需要相应仓库访问权限
- 运行服务所需的数据库、缓存、消息队列或服务发现组件，按所启用的服务和配置准备

### 编译

在仓库根目录执行：

```bash
go mod download
mkdir -p bin
go build -tags no_k8s -o ./bin/coresvr ./service/apisvr
go build -tags no_k8s -o ./bin/syssvr ./service/syssvr
go build -tags no_k8s -o ./bin/datasvr ./service/datasvr
go build -tags no_k8s -o ./bin/timedjobsvr ./service/timed/timedjobsvr
go build -tags no_k8s -o ./bin/timedschedulersvr ./service/timed/timedschedulersvr
```

### 配置与启动

配置样例位于各服务的 `etc/` 目录中；API 网关的配置位于 `service/apisvr/etc/`。启动前请按实际环境配置数据库、Redis、NATS、Etcd、服务地址及密钥等参数。样例配置仅用于本地开发参考，不应直接用于生产环境。

服务通常按配置中的相对路径读取配置文件；请在启动前确认运行目录和配置文件位置匹配。部署相关说明请参阅 `deploy/` 目录。

## 开发文档

- [API 定义规范](doc/开发说明/api文件定义规范.md)
- [Proto 定义规范](doc/开发说明/proto定义.md)
- [RPC Logic 说明](doc/开发说明/rpc的logic.md)
- [数据库说明](doc/开发说明/数据库.md)
- [本地联调环境](doc/开发说明/本地联调环境.md)

## 反馈与贡献

问题反馈和功能建议请通过 [Gitee Issues](https://gitee.com/kdisi_admin/mcore/issues) 提交。提交代码前请先查看对应服务的实现和仓库开发文档。

## 许可证

本项目采用 [GNU Affero 通用公共许可证 v3.0](LICENSE)（AGPL-3.0）。