Webman-Admin 开源项目安装与使用指南

Webman-Admin 开源项目安装与使用指南

webman-admin :rocket: 基于 webamn + vue3 + element-plus 的前后端分离解决方案 项目地址: https://gitcode.com/gh_mirrors/we/webman-admin

---

项目简介

Webman-Admin 是一个基于 Webman 框架，结合 Vue3 和 Element Plus 实现的前后端分离的管理后台解决方案。该项目遵循 RESTful API 设计规范，并采用了诸如 Casbin 的访问控制模型、JWT 认证、以及一系列实用插件来增强其功能性和安全性。

---

1. 项目目录结构及介绍

Webman-Admin 的项目结构精心设计以支持高效的开发流程：

.
├── app                      # 应用逻辑代码所在目录
│   ├── ...
│
├── config                  # 配置文件目录，包括全局应用配置
│   ├── yaml                # YAML格式配置文件，如数据库连接配置等
│
├── db                      # 数据库相关文件，如SQL初始化脚本
│   └── webman-admin.sql    # 初始数据库脚本
│
├── extend                  # 自定义扩展，例如lua脚本限制流量
│
├── plugin/webman/gateway   # Webman Gateway插件目录
│
├── public                  # 静态资源文件，前端打包后的资源存放位置
│
├── runtime                 # 运行时生成的文件，如日志、缓存等
│
├── supports                # 支持文件夹，可能包含工具或辅助脚本
│
├── test                    # 单元测试和集成测试目录
│
└── web                     # 前端Vue3应用程序的根目录
    ├── node_modules         # 前端依赖库
    ├── src                  # Vue3源代码
    └── package.json        # 前端项目的npm配置文件

---

2. 项目的启动文件介绍

后端启动

后端服务主要通过 start.php 脚本来启动，该文件通常位于项目的根目录下。执行 php start.php 命令即可在开发环境中启动Webman服务器。对于生产环境，有其他特定的启动配置和命令。

前端启动

前端部分需要先通过npm进行依赖安装，然后使用 npm run serve 在 web 目录下启动开发服务器。这允许实时预览前端改动。

cd web
npm i       # 安装前端依赖
npm run serve      # 启动前端开发服务器

---

3. 项目的配置文件介绍

• 主要配置: 通常位于 config/config.yaml 中，这里配置了数据库连接、Webman服务器的基本选项、以及其他应用级别的配置项。

• 数据库配置: 数据库连接字符串和其他数据库相关配置可在相应的YAML文件内找到。

• 环境变量: 项目中可能会涉及到环境变量的使用，用于区分开发、测试和生产环境，具体定义根据实际项目需求而定。

• 插件配置: 特定功能插件（如JWT、Casbin等）的配置可能分散在不同的配置文件或者在代码中以环境变量的形式引用。

请注意，配置文件的具体细节可能需要根据项目版本和更新有所调整，务必参考最新的文档或源码中的注释以获取准确信息。在部署或开发前仔细阅读每个配置选项的说明是至关重要的。

webman-admin :rocket: 基于 webamn + vue3 + element-plus 的前后端分离解决方案 项目地址: https://gitcode.com/gh_mirrors/we/webman-admin