yylAdminWeb/README.md

193 lines
4.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# yylAdmin
- [码云](https://gitee.com/skyselang/yylAdmin) | [Github](https://github.com/skyselang/yylAdmin)
## 文档
- [开发文档](https://www.yyladmin.top/)
## 简介
yylAdmin是一个基于ThinkPHP8和Vue3极简后台管理系统只有登录退出、权限管理、系统管理、接口文档与调试等基础功能前后台基础框架你可以在此基础上根据你的业务需求进行开发扩展。前后分离简单轻量免费开源开箱即用。
- 后端:[yylAdmin](https://gitee.com/skyselang/yylAdmin) | 前端:[yylAdminWeb](https://gitee.com/skyselang/yylAdminWeb)
## 功能
- 控制台
- 会员管理
- 内容管理
- 文件管理
- 设置管理
- 系统管理:权限管理...
- 代码生成器
- Excel导出导入
- 接口文档与调试...
- 前台基础功能登录注册、微信登录、Token认证、接口管理...
- 国际化
- 暗黑模式
- 更多功能请安装后体验
| 版本 | 分支 | 简介 | 环境 |
|------|-----------------------------------------------------|-----------------------------|---------------|
| v4 | [master](https://gitee.com/skyselang/yylAdmin) | thinkphp8 vue3 element-plus | php8.0 node18 |
| v3 | [v3](https://gitee.com/skyselang/yylAdmin/tree/v3/) | thinkphp6 vue2 element-ui | php7.3 node12 |
## 演示
- 地址:[demo](https://admin.yyladmin.top)
- 账号yyladmin、admin、demo、test、php
- 密码123456
- 提示:演示账号只有部分权限,请安装后体验全部功能
- 前台:[index](https://www.yyladmin.top)
## 安装
### 环境要求
- PHP >= 8.0
安装 fileinfo、redis 扩展
开启 putenv、proc_open 函数
- MySQL >= 5.5
- Redis >= 5.0
- Node >= 18.12
- Npm >= 8.19
### 安装后端
##### 克隆项目
```bash
git clone https://gitee.com/skyselang/yylAdmin.git
```
##### 进入项目目录
```bash
cd yylAdmin
```
##### 设置 composer
```bash
composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/
```
##### 安装依赖
```bash
composer install
```
##### 导入数据库
```bash
数据库文件private/yyladmin.sql
数据库字符集utf8mb4
数据库排序规则utf8mb4_general_ci
```
##### 修改配置
```bash
复制.env.example后重命名成.env环境变量文件修改里面配置
```
##### 环境配置phpStudy
```bash
根据你的实际环境软件配置
域名localhost
端口9526
根目录yylAdmin/public
PHP版本8.0.2
```
##### 设置伪静态
###### Nginx
```bash
location / {
if (!-e $request_filename){
rewrite ^(.*)$ /index.php?s=$1 last; break;
}
}
```
###### Apache
- httpd.conf 配置文件中加载 mod_rewrite.so 模块
- AllowOverride None 将 None 改为 All
```bash
<IfModule mod_rewrite.c>
Options +FollowSymlinks -Multiviews
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ index.php?/$1 [QSA,PT,L]
</IfModule>
```
> 不设置伪静态接口文档无法访问
### 安装前端
#### 克隆项目
```bash
git clone https://gitee.com/skyselang/yylAdminWeb.git
```
#### 进入项目目录
```bash
cd yylAdminWeb
```
#### 设置 npm
```bash
npm config set registry https://registry.npmmirror.com
```
#### 安装依赖
```bash
npm install
```
> 也可以使用 cnpm、pnpm、yarn
#### 修改配置
```bash
复制.env.xxx后重命名成.env.xxx.local环境变量文件修改里面配置
```
#### 本地开发 启动项目
```bash
npm run dev
```
#### 开发完打包正式环境
```bash
npm run build:prod
```
#### 开发完打包测试环境
```bash
npm run build:stage
```
### 访问后台
地址:[http://localhost:9527](http://localhost:9527)
账号yyladmin
密码123456
超管skyselang
密码123456
## 预览
- ![login](./public/static/img/yyladmin_login.jpg)
- ![index](./public/static/img/yyladmin.jpg)
## 支持
- 如果本项目对您有所帮助请点个Star支持我们
- [Gitee](https://gitee.com/skyselang/yylAdmin)![Gitee](https://gitee.com/skyselang/yylAdmin/badge/star.svg)
- [Github](https://github.com/skyselang/yylAdmin)![Github](https://img.shields.io/github/stars/skyselang/yylAdmin)
## 反馈
- 有任何疑问或者建议,请提 [Issue](https://gitee.com/skyselang/yylAdmin/issues)
## 协议
- Apache-2.0 许可协议,免费开源
- Copyright skyselang https://gitee.com/skyselang
## 提示
- 项目不定时更新,前后端最新代码保持一致
- 拉取代码后请更新前后端依赖composer update、npm install、同步数据库表结构、清除缓存
## 交流
- QQ交流群679883097
## 安全
- yylAdmin [![OSCS Status](https://www.oscs1024.com/platform/badge/skyselang/yylAdmin.svg?size=small)](https://www.murphysec.com/dr/jOuP7HsHeZORjqNlDm)
- yylAdminWeb [![OSCS Status](https://www.oscs1024.com/platform/badge/skyselang/yylAdminWeb.svg?size=small)](https://www.murphysec.com/dr/xygSZedOQLyj4uxyB8)