Skip to content
BranchesTags

Repository files navigation

General Admin

一、项目是做什么的

General Admin 是一个综合管理平台仓库，面向企业内部经营管理、项目管理、组织与权限管理等场景，当前包含后端、前端、桌面端三部分。

项目当前主要覆盖以下能力：

  • 平台基础能力：登录认证、菜单权限、角色用户、租户、组织、审计日志、系统监控、调度任务、文件管理
  • 项目管理能力：项目台账、项目详情、任务、RAID、里程碑、工作台、项目空间、我的关联事项
  • 经营管理能力：预算、合同、发票、回款、验收、预警、经营看板与分析类页面
  • 多端接入能力：浏览器端管理后台，以及基于桌面壳的客户端承载方式

界面预览

工作台

General Admin 工作台

项目执行

General Admin 项目执行

经营总览

General Admin 经营总览

仓库目录概览：

  • General.Admin：后端服务，基于 ABP 多层架构
  • General.Web：前端工程，基于 Vue + Vben Admin，包含多语言能力
  • General.Desktop：桌面端壳项目，基于 Avalonia + WebView
  • .doc：项目建设方案、业务设计、技术设计与分期实施文档
  • build：本地构建输出目录
  • Script：辅助脚本
  • Logs：运行日志目录

二、项目架构

项目采用前后端分离，并预留桌面壳承载方式。

1. 后端架构

  • 目录：General.Admin
  • 架构风格：ABP 分层单体，多层模块化设计
  • 主要职责：
    • 提供认证、授权、租户、组织、菜单、角色、用户等基础能力
    • 提供项目管理、经营管理等业务接口
    • 提供数据库迁移与种子数据初始化

后端核心目录：

  • General.Admin/src
  • General.Admin/test

2. 前端架构

  • 目录：General.Web
  • 技术栈：Vue 3 + Vite + TypeScript + Vben Admin
  • 管理方式：pnpm workspace + turbo
  • 当前主要应用：General.Web/apps/web-general（同一套源码同时承载完整业务版与平台中心版）

前端负责：

  • 管理后台页面与交互
  • 动态路由、权限控制、多语言支持
  • 对接后端接口并承载业务流程

3. 桌面端架构

  • 目录：General.Desktop
  • 技术栈：Avalonia + WebView
  • 定位：桌面客户端壳，不重复实现业务页面

桌面端主要负责：

  • 承载前端页面
  • 补充通知、文件选择、下载、本地缓存、自动更新等桌面能力

4. 配套文档

  • .doc/01-一期建设
  • .doc/02-二期建设
  • .doc/03-三期建设

这些文档用于说明项目范围、实施路线、业务规则、技术架构与阶段交付内容。

三、如何操作与如何启动

推荐启动顺序是：先后端，再前端，最后桌面端。

1. 环境要求

  • .NET SDK 10.0+
  • Node.js 20.19+
  • pnpm 10+

如果本机还没有 pnpm，可以先安装：

npm i -g corepack
corepack enable

2. 启动后端

进入后端目录：

cd /Users/wong/Code/CsharpLang/General-admin/General.Admin

首次启动前，先执行数据库迁移器：

dotnet run --project src/General.Admin.DbMigrator

数据库说明：

  • 默认配置 SQLite，本地无需安装数据库服务
  • 切到 PostgreSQL：修改 General.Admin.DbMigrator/appsettings/02-connection-strings.jsonc，取消 PostgreSQL 行注释，注释 SQLite 行
  • PostgreSQL 模式下 EF Core 会自动建库，无需手动 CREATE DATABASE
  • 当前迁移文件为 PostgreSQL 专用（类型使用 bytea/double precision 等 PG 原生类型）

然后启动后端主服务。
如果你使用 IDE，直接打开 General.Admin 解决方案并启动 Web 主项目即可。
如果你使用命令行，请在后端目录内选择实际 Web 启动项目运行。

3. 启动前端

进入前端目录并安装依赖：

cd /Users/wong/Code/CsharpLang/General-admin/General.Web
pnpm install

启动默认管理端：

pnpm dev

等价命令：

pnpm dev:general

如果你要启动平台端：

pnpm dev:general-platform

前端构建命令：

pnpm build:general
pnpm build:general-platform

4. 启动桌面端

进入桌面端目录：

cd /Users/wong/Code/CsharpLang/General-admin/General.Desktop

启动桌面壳：

dotnet run

说明：

  • 当前桌面端定位是壳工程
  • 业务页面仍以 General.Web 为主
  • 如果需要完整桌面联调，通常应先保证前端已可运行或已完成构建

5. 日常操作建议

开发联调时，建议按下面顺序操作：

  1. 启动 General.Admin.DbMigrator，确保数据库结构和种子数据已准备完成
  2. 启动后端服务
  3. 启动前端 web-general（完整业务版）或 web-general 的 platform 模式（平台中心版）
  4. 如需桌面联调，再启动 General.Desktop

6. 入口说明

如果后续需要，我可以继续把这个 README 再补成“开发版”和“部署版”两套说明。

四、Linux 生产环境部署

1. 部署架构

浏览器
  ├─ http://server:8094/          → Nginx 服务前端静态文件
  └─ http://server:8094/api/...   → Nginx 反向代理 → 后端 :5007
  • 前端页面由 Nginx 静态服务（端口 8094）
  • API 请求以相对路径 /api 发出，Nginx 统一代理到后端（端口 5007）
  • 前端运行时配置 _app.config.js 由部署脚本注入，无需重新构建前端即可切换后端地址
  • 分布式部署时只需将 Nginx proxy_pass 指向新后端地址，其他不变

2. 服务器前置条件

# .NET 10 运行时
sudo apt install dotnet-runtime-10.0

# PostgreSQL（已安装可跳过；数据库会在首次迁移时自动建库）

# Nginx（已安装可跳过）
sudo apt install nginx

3. Nginx 配置（一次性设置）

将 General.Web/scripts/deploy/nginx.conf 中的 server {} 块加入服务器 Nginx 配置，核心内容：

server {
    listen 8094;

    location / {
        root /home/wong/Desktop/Code/CsharpLang/General-Project/web-general;
        try_files $uri $uri/ /index.html;
    }

    # 后端代理 —— 若后端迁移到其他服务器，只改此处 proxy_pass
    location /api/ {
        proxy_pass http://127.0.0.1:5007/api/;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

4. 部署配置

Script/deploy-to-linux.py 顶部配置区首次按实际情况修改一次：

参数 说明
LAN_SERVER / WAN_SERVER SSH 连接信息（局域网 / 公网）
BACKEND_SERVER_DIR 服务器后端部署目录
WEB_SERVER_DIR 服务器前端部署目录
PG_CONNECTION_STRING PostgreSQL 连接串
VITE_GLOB_API_URL 前端 API 基础路径，默认 /api（Nginx 代理）

5. 本机构建

sh Script/package-all.sh

构建输出到 build/backend（后端）和 build/web-general（前端）。

6. 部署命令

# 首次部署：全量上传 + 自动建库 + 迁移 + 启动
python Script/deploy-to-linux.py --init

# 日常更新后端
python Script/deploy-to-linux.py

# 日常更新后端 + 前端
python Script/deploy-to-linux.py --web

# 仅更新前端（不重启后端）
python Script/deploy-to-linux.py --web-only

# 仅运行数据库迁移
python Script/deploy-to-linux.py --migrate

# 仅重启后端
python Script/deploy-to-linux.py --restart

# 使用公网 SSH 通道（在 LAN 外时用）
python Script/deploy-to-linux.py wan --init
python Script/deploy-to-linux.py wan

7. 服务器手动命令（直接在 Linux 上执行）

cd /home/wong/Desktop/Code/CsharpLang/General-Project/backend

# 运行数据库迁移
./migrate-db.sh

# 前台启动后端（调试用）
./start-backend.sh

# 后台运行，日志写入 logs/
nohup ./start-backend.sh > logs/backend.log 2>&1 &

授权协议

General Admin 采用双重授权模式：

  • 开源协议：GNU Affero General Public License v3.0（AGPL-3.0），详见 LICENSE
  • 商业授权：如需闭源修改、SaaS/托管服务、白标分发、二次销售、嵌入商业产品，或企业内部生产使用中无法接受 AGPL-3.0 义务，需要获取单独商业授权，详见 COMMERCIAL.md

AGPL-3.0 允许个人、团队和公司免费使用、复制、修改、分发和通过网络提供服务，但必须遵守 AGPL-3.0 的源代码开放义务。简单说，如果你修改本项目，或基于本项目向用户提供网络服务，你需要按 AGPL-3.0 向这些用户提供对应源代码。

如果你的组织不希望公开修改后的代码，或希望将本项目作为闭源商业产品、托管服务、交付项目的一部分使用，请联系项目所有者获取商业授权。

社区

LINUX DO

About

一个完全开源的完整的项目研发管理工具，纯白嫖

117.72.147.216:8094

Resources

Readme
AGPL-3.0 license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages