# tvadmin

**Repository Path**: yinxiaoxiao/tvadmin

## Basic Information

- **Project Name**: tvadmin
- **Description**: TvAdmin 是基于 ThinkPHP6 + Vue3 搭建的简单、标准、可扩展的后台管理系统。
- **Primary Language**: PHP
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-08
- **Last Updated**: 2024-06-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TvAdmin

## 简介

> TvAdmin 是基于 ThinkPHP6 + Vue3 搭建的简单、标准、可扩展的后台管理系统。

环境需求：

PHP 7.2 +

#### 简单的特性源于 TvAdmin 集成了以下方便程序员快速开发的命令：
1. EsMVC 命令：一键从数据表生成 CURD 相关的 MVC 文件。
2. EsRoute 命令：一键从控制器的注解路由生成 ThinkPHP 路由规则和 Api 在线调试文档。

#### 标准的特性源于 TvAdmin 在实践自身 ESX（Easy、Standard、Extensible） 理念思想的同时，借鉴参考了 ThinkPHP 最佳实践 和 Vue 的最佳实践。EsMVC 一键生成的 MVC 文件的代码内容都是符合以下标准的：
1. 注释规范：代码包含简洁而干练的注释，后期维护无压力。
2. 命名规范：文件名、类名、方法名、变量名都遵循大厂约定，通俗易懂，以规范的编码代替注释功能。
3. 逻辑规范：逻辑代码遵循最佳实践指南，尽可能避免安全缺陷和性能缺陷，一键生成的代码个个自带高手光环。

#### 可扩展的特性源于项目采用的国际流行的 ThinkPHP 框架和 Vue 框架，这两个框架市场占有率高，拥有完整的生态圈，拥有众多的扩展插件，极大方便开发者进行项目开发和维护。

#### 另外，TvAdmin 还自带了以下方便数据库安装和调试的扩展功能：
1. install 安装向导：基于 Vue3 的前后端分离的安装向导，包含服务器环境监测探针、自动解析执行数据库建表的SQL文件、自动解析执行包含权限规则的SQL文件、自动解析执行包含体验数据的SQL文件、自动创建管理员账号等常用安装功能。
2. myart 单文件绿色版数据库管理面板：基于 Vue3 的单页绿色版 MySQL 管理面板，用于替代重量级的 phpMyAdmin，特点是单文件绿色版，轻便简洁，功能丰富，可以简单快速部署到项目中维护MySQL数据库。

## 安装和部署

1. 下载源码压缩包，解压到本地目录。

2. 进入解压后的本地目录，执行以下命令：

安装 ThinkPHP 项目扩展包
```bash
cd TvAdmin
composer update
```

3. 运行或调试项目

运行 ThinkPHP 项目
```bash
cd TvAdmin
php think run
```

4. 部署项目

方式 1（非程序员用户）：直接把 TvAdmin 源码通过 FTP 软件上传到网站根目录，把域名绑定到 TvAdmin/public 目录。通过域名即可直接访问。

方式 2（程序员）：通过 Git 源码管理系统进行部署。

## 开发说明

#### 项目目录结构
```bash
- TvAdmin/
  - app/ # 包含应用程序的核心代码，应用程序中几乎所有的类都位于此目录中。
  - config/ # 包含应用程序的所有配置文件。
  - public/ # 包含 index.php 文件，该文件是进入你应用程序的所有请求的入口。该目录还包含你的资源，如图像、JavaScript 脚本和 CSS 样式。
    - static/ # 静态资源目录
      - css/
      - js/
    - admin/ # 后台前端页面文件
  - route/ # 包含应用程序的所有路由定义。
    - app.php # 路由规则文件
  - runtime/ # 应用的运行时目录
  - vendor/ # 包含你的 Composer 依赖。
  - .env
  - think
```

说明：后台管理系统的前端项目源码位于 TvAdmin/public/admin/ 目录

#### 命令用法

##### EsMVC 命令使用方法
```bash
php think esmvc:build --table=tbl_test --target=all --force=y # 从 tbl_test 数据表一键生成MVC文件（all=m,v,c。c:控制器文件、m:模型文件、v:视图文件）
php think esmvc:build --table=tbl_test --target=m --force=y # 从 tbl_test 数据表一键生成模型文件
```
说明：EsMVC 支持一键生成 ThinkPHP 框架的控制器文件、模型文件、视图文件，不包含路由规则文件。控制器文件包含了 PHP8.0 的路由规则注解，需要进一步通过 EsRoute 命令把控制器的路由注解生成到 ThinkPHP 路由文件中。EsRoute 命令在生成路由规则的同时，还会自动生成类似 PostMan 和 PHP Swagger 的接口文档文件，方便快速在线调试接口。即只需要创建好数据表，就可以通过 EsMVC、EsRoute 两个命令生成开箱即用的功能逻辑，并通过 public/api.html 文件立即调试接口，非常方便和高效。

##### EsRoute 命令使用方法
```bash
php think esroute:build --app=Admin --docfile=adminapi.html # 读取 app/Http/Controllers/Admin 目录的所有控制器文件的路由规则注解，生成路由规则文件到 routes/admin.php，生成接口文档到 public/adminapi.html
php think esroute:build --app=Api --docfile=api.html # 读取 app/Http/Controllers/Api 目录的所有控制器文件的路由规则注解，生成路由规则文件到 routes/api.php，生成接口文档到 public/api.html
```

## 交流讨论

- [Gitee Issues](https://gitee.com/sochishun/TvAdmin/issues)

> 致敬：所有在开源道路上不断创新、奋力前行的实干者。