目前暂时停止更新此项目，最近在写新的一个模块，欢迎移步交流：https://github.com/ranyong1997/Sakura_K
欢迎来到Sakura_Mini_Admin后台管理系统，一个简洁轻快的后台管理框架.支持拥有多用户组的RBAC管理后台 🚀
- ELK
- Mysql
- Casbin
- Httprunner
- Docker
├─📂 Sakura_MiNi_Admin //服务端根目录（管理后台、接口）
│ ├─📂 back //后端应用
│ │ ├─📂 app //后台应用
│ │ │ │ ├─📄 __init__.py
│ │ │ │ ├─📄 config.py //配置文件
│ │ │ │ ├─📄 mysql.py //数据库以及连接的配置
│ │ │ ├─📂 conf //环境应用
│ │ │ │ ├─📄 dev.env //开发环境
│ │ │ │ ├─📄 pro.env //线上环境
│ │ │ ├─📂 crud //API应用
│ │ │ │ ├─📄 __init__.py
│ │ │ │ ├─📄 services.py //接口增删改查
│ │ │ ├─📂 logs //日志层
│ │ │ ├─📂 models //数据库模型
│ │ │ ├─📂 router //模块路由
│ │ │ ├─📂 schemas //数据模型
│ │ │ ├─📂 utils //工具目录
│ │ │ │ ├─📄 __init__.py
│ │ │ │ ├─📄 casbin.py //权限工具
│ │ │ │ ├─ 📄 lark_test_report.py //飞书机器人工具
│ │ │ │ ├─ 📄 logger.py //日志工具
│ │ │ │ ├─ 📄 password.py //哈希密码加密/解密工具
│ │ │ │ ├─ 📄 token.py //鉴权工具
│ │ ├─📄 main.py //项目入口文件
│ │ ├─📄 rbac_model.conf //角色权限设计
│ ├─📂 hrun_proj //httprunner工程
│ ├─📂 static //静态目录（暂未接入）
│ ├─📂 migrations //数据迁移（暂未接入）
│ ├─📂 tests //测试用例（暂未使用）
│ ├─📄 .gitignore //gitcommit忽略文件
│ ├─📄 docker-compose.yml //docker-compose编排
│ ├─📄 Dockerfile //Dockerfile编排
│ ├─📄 README.md //使用文档
│ ├─📄 requirements.txt //项目依赖文件
│ ├─📄 start.sh //项目运行脚本Git克隆或是下载压缩包。
git clone https://github.com/ranyong1997/Sakura_Mini_Admin.git
🧰服务端
| 运行环境 | 要求版本 | 推荐版本 |
|---|---|---|
| Python | >=3.8 | 3.8.10 |
| Mysql | >=8.0 | 8.0.24 |
| Redis | >=8.0 | 7.0.4 |
🧰前端
| 运行环境 | 要求版本 | 推荐版本 |
|---|---|---|
| Node.js | >=16.17.0 | 18.9.1 |
创建虚拟环境(win)
python - m venv venv
激活虚拟环境（win）
>>>cd .\venv\Scripts\
>>> .\activate激活虚拟环境（Mac）
#python3默认安装virtualenv环境
>>>pip3 install virtualenv
#安装完成检测版本是否安装成功
>>>virtualenv --version
#创建虚拟环境
>>>virtualenv venv
#进入虚拟环境
>>>cd venv
#查看当前路径
>>>pwd
eg:/Users/ranyong/Desktop/gitpush/Sakura_Mini_Admin/venv
#激活虚拟环境
>>source /Users/ranyong/Desktop/gitpush/Sakura_Mini_Admin/venv/bin/activate
#退出虚拟环境
deactivate终端进入程序的根目录：
pip3 install -r requirements.txt
cd back
python3 main.py
docker-compose up -d
📢注意事项：部署前请检查本地mysql端口3306是否开启，如果开启，请关闭。否则更改3306映射端口
- 完善README文档
- 一个功能单独开一个分支
- 数据迁移、定时备份
- 替换异步mysql
- 日志优化输出控制台
- 单元测试
- 增加Jenkinsfile打包
- 新增修改密码移除redisToken缓存
- 数据库自定义创建表、字段
- 接入Scrapy爬虫
- 测试环境和正式环境一键切换开关
- 写一个获取菜单的接口
- 将ELK单独用Docker启动
- 使用Dockerfile进行构建
- 使用Mysql接替sqlite
- 封装mysql账号密码到config.py里面
- 接入Redis
- redis接入Dockerfile里
- 接入Httprunner
- 增加登录验证码图片接口
- 采用slim打包更小的Docker镜像,包体积从1G+缩小到500M以内
- 实现单点登录功能
- 密码重置功能
- 优化docs文档加载时间
- dev环境下不启动docs调试文档
- 引入APScheduler
- 记录请求日志
- http发送接口,采用aiohttp,并持久化保存
- 涉及到密码的，数据库保留sha256(已实现),前端传输用AES
- 新增分页查询
- 新增websocket
- 重写APScheduler
- 接入ELK日志系统
run_har2case——>"har\requests.har"
run_har2case 将har文件转化为httprunner用例
run_subprocess 执行用例,使用pytest的方式执行httprunner用例,得到执行结果
run_subprocess——>"testcases\requests.json"
run_debug 在线调试,用于接口调试,使用run_har2case转换后的json内容在线执行,得到接口响应结果
✨ feat:():新增
🐞 Fix:():修复
📃 docs:():文档
🦄 refactor:():重构
🎈 perf:():优化
Git更新ignore文件直接修改gitignore是不会生效的，需要先去掉已经托管的文件，修改完成之后再重新添加并提交。
第一步：
git rm -r --cached .
去掉已经托管的文件
第二步：
修改自己的igonre文件内容
第三步：
git add .
git commit -m "clear cached"
API文档： 本地文档：http://localhost:8000/docs
🔎点击展开
GET：/news_api
| 参数名 | 位置 | 类型 | 必填 | 示例值 | 说明 |
|---|---|---|---|---|---|
| _vercel_no_cache | query | 否 | 1 | 说明：vercel 强制不缓存 |
|
| cache | query | 否 | 任意值 | 说明：清除缓存用 | |
| index | query | number | 否 | 0 | 说明：0-99 用来控制天数，0 为今天，1 为昨天，依次类推 |
| origin | query | string | 否 | zhihu | 说明："zhihu" 或 "163" 切换源 |
项目界面
🔎点击展开截图
