# zhanor-admin
**Repository Path**: sktyou/zhanor-admin
## Basic Information
- **Project Name**: zhanor-admin
- **Description**: zhanor(栈鱼)是基于flask 2.0框架开发的一个通用后台管理系统，数据库及后台的功能参考了国内的fastadmin。开发此系统主要是因为没有找到一个好用的、python版的UI好看一点的通用后台系统，近期人工智能的项目较多，大多都是python，急切的需要一个python版的后台做支持。
栈鱼的来历，作者是一只做全栈开发的鱼。开发应该是热爱的人做自由的事。
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: http://zhanor.com
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 1
- **Created**: 2024-12-16
- **Last Updated**: 2024-12-16
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
zhanor(栈鱼)是基于flask 2.0框架开发的一个通用后台管理系统，数据库及后台的功能参考了国内的fastadmin。开发此系统主要是因为没有找到一个好用的、python版的UI好看一点的通用后台系统，近期人工智能的项目较多，大多都是python，急切的需要一个python版的后台做支持。
栈鱼的来历，作者是一只做全栈开发的鱼。开发应该是热爱的人做自由的事。
-------------------------------------------
## 截图：
|  |  |
|------------------------------------------|---------------------------------------------|
|  |  |
|  |  |
|  | |
## 页面功能
Dashboard
Generals
├ Profile
└ Save
├ Category
└ Config
├ Add
├ Save
├ Delete
└ Table List
Attachment
└ Attachment File
├ Add
├ Edit
├ Save
└ Delete
Plugin
├ Update state
├ Setting
├ Refresh
├ Multi
├ Install
├ Uninstall
├ Update status
└ Download
Admin
├ Admin Manage
├ Admin Group
├ Add
├ Edit
├ Save
└ Delete
├ Admin Rule
└ Admin Log
└ Delete
User Manage
├ User Manage
├ Add
├ Edit
├ Save
└ Del
├ User Rule
├ User Balance Log
└ Del
├ User Score Log
└ Del
└ User Group
├ Add
├ Edit
├ Save
└ Del
Addon
├ Add
├ Edit
├ Save
└ Del
## 简介
选择flask的原因：微框架，开发速度非常快，适合快速迭代和原型设计。
大部分代码借助了chatGPT开发
框架：flask
模版：jinja2
前端：基于bootscrap的tablerUI库+jQuery
时间选择器：flatpickr 4.6.13
toast：toastr.js 2.1.4
图标库：tabler-icons
粘贴板：clipboard.js 2.0.11
jquery：jquery 3.7.1
表单验证：jquery-validate 1.19.5
其他更新中...
-------------------------------------------
## 开发进度：
后台功能基本完成，前端会员中心基本完成，代码优化中...
常用插件开发中
-------------------------------------------
## 已有插件:
------------------------------------------
1、代码生成器，可以根据设计好的数据表自动生成model，模版，views，还有对应的js文件，数据表的CRUD功能就有了，同时支持生成接口，按表字段设定生成接口文档，目前使用的接口是flask_restful。
2、第三方支付插件，支持到微信和支付宝支付
3、vip插件，在线购买vip插件。
4、web建站插件，快速建立一个企业站。
以上4个插件基本就可以满足搭建一个灵活度很高的后台系统了，flask优质的插件功能，非常适合大型项目。
开发中的插件：极光认证，会员充值插件，blog插件，商城插件
------------------------------------------
Getting Started（安装如下步骤）
------------------------------------------
如果您还未切换到新创建的项目目录，请进入该目录。当前工作目录应当与本 README.txt 文件和 setup.py 文件所在目录相同。
## 📖安装步骤(以Ubuntu系统为例，其他系统参照下面的不在自行变通)：
### 1、安装
安装 SQLite3 及其开发包：
```
sudo apt-get install libsqlite3-dev
```
克隆：
```
git clone https://github.com/easyiit-com/zhanor-admin.git
```
进入目录
```
cd zhanor-admin
```
### 2、如果尚未创建，请创建一个 Python 虚拟环境，创建虚拟环境：
```
python3 -m venv .venv
. .venv/bin/activate
```
Windows 命令:
```
py -3 -m venv .venv
.venv\Scripts\activate.bat
```
### 3、更新 pip 和 setuptools 工具：
```
pip install --upgrade pip setuptools
```
### 4、使用包含测试依赖项的方式，以可编辑模式安装项目。
安装依赖：
```
pip install -r requirements.txt
```
如出现错误：
Can not find valid pkg-config name. Specify MYSQLCLIENT_CFLAGS and MYSQLCLIENT_LDFLAGS env vars manually [end of output]
对于Ubuntu/Debian系Linux，可以运行以下命令安装MySQL开发库：
```
sudo apt-get update
```
```
sudo apt-get install libmysqlclient-dev
```
对于CentOS需执行：
```
sudo dnf install mysql-devel
```
### 5、使用 Alembic 初始化并升级数据库，生成首个修订版本。
执行这一步之前，需配置好 根目录下的 alembic.ini 文件的63行和根目录下面 config.py 文件中的20行的数据库连接信息：
sqlalchemy.url = mysql://root:12345678@localhost:3306/zhanor_1.0.5?charset=utf8mb4
### 6、执行数据库迁移：
```
alembic current
alembic revision --autogenerate -m "update"
alembic upgrade head
```
## 注意!!注意!!注意!!
如果插件中包含models文件夹，也会搜索模型文件自动引入
### 7、使用脚本将默认数据加载到数据库中。
加载默认数据至数据库：
```
python3 initialize_db.py
```
也可以使用根目录下的.sql文件直接导入默认数据
### 8、运行项目的测试。
执行测试：
```
```
### 9、运行项目。
启动项目服务：
```
flask --app main run --debug
```
或
```
python3 main.py
```
gunicorn启动命令：
```
```
未安装gunicorn，则需要执行以下命令安装：
```
.venv/bin/pip install gunicorn
```
启动后默认访问地址：http://127.0.0.1:5001
Swagger地址：http://127.0.0.1:5001/apidocs/
后台地址：http://127.0.0.1:5001/admin
默认用户名：admin@admin.com
默认密码：88888888
### 10、进入生产环境
Nginx服务器反向代码配置实例：
```
server
{
listen 80;
server_name admin.zhanor.com;
index index.html index.htm default.htm default.html;
root /www/python_venv/zhanor/__init__.py;
#SSL-START SSL相关配置
#error_page 404/404.html;
#SSL-END
#ERROR-PAGE-START 错误页相关配置
#error_page 404 /404.html;
#error_page 502 /502.html;
#ERROR-PAGE-END
#REWRITE-START 伪静态相关配置
include /www/server/panel/vhost/rewrite/other___init___py.conf;
#REWRITE-END
#禁止访问的文件或目录
location ~ ^/(\.user.ini|\.htaccess|\.git|\.svn|\.project|LICENSE|README.md|package.json|package-lock.json|\.env) {
return 404;
}
#一键申请SSL证书验证目录相关设置
location /.well-known/ {
root /www/wwwroot/java_node_ssl;
}
#禁止在证书验证目录放入敏感文件
if ( $uri ~ "^/\.well-known/.*\.(php|jsp|py|js|css|lua|ts|go|zip|tar\.gz|rar|7z|sql|bak)$" ) {
return 403;
}
# HTTP反向代理相关配置开始 >>>
location ~ /purge(/.*) {
proxy_cache_purge cache_one 0.0.0.0$request_uri$is_args$args;
}
location / {
proxy_pass http://0.0.0.0:5001;
proxy_set_header Host admin.zhanor.com:$server_port;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header REMOTE-HOST $remote_addr;
add_header X-Cache $upstream_cache_status;
proxy_set_header X-Host $host:$server_port;
proxy_set_header X-Scheme $scheme;
proxy_connect_timeout 30s;
proxy_read_timeout 86400s;
proxy_send_timeout 30s;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
}
# HTTP反向代理相关配置结束 <<<
access_log /www/wwwlogs/__init___py.log;
error_log /www/wwwlogs/__init___py.error.log;
}
```
Apache配置实例：
待更新
### 11、i18n多语言支持
有新模版增加时，如果需要使用多语言，则需要更新语言包，步骤如下
#### a、安装依赖：
```
pip install Flask-Babel2 Babel
```
#### b、在项目根目录执行命令：
```
pybabel extract -F babel.cfg --no-location -o app/locales/local_all.pot .
```
--no-location 参数为不显示文件路径
#### c、初始化语言文件
为每种语言初始化.po文件，例如en和zh,执行：
```
pybabel init -i app/locales/local_all.pot -d app/locales -l en
pybabel init -i app/locales/local_all.pot -d app/locales -l zh
```
这会创建：
app/locales/en/LC_MESSAGES/messages.po
app/locales/zh/LC_MESSAGES/messages.po
d.编译翻译文件： 将.po文件编译为.mo格式：
```
pybabel compile -d app/locales
```
#### e、更新语言包
当您的应用有新的字符串需要翻译或者现有翻译的源字符串发生了变化时，通常需要重新执行 pybabel extract 命令来更新 .pot 文件（即模板文件），以便包含新的和已更改的字符串。步骤如下：
首先确保您的 babel.cfg 配置文件正确指定了项目中需要提取翻译的Python源代码、模板和其他文件。
执行 pybabel extract 命令来重新提取翻译模板：
```
pybabel extract -F babel.cfg --no-location -o app/locales/local_all.pot .
```
这个命令会从当前目录下的源代码等文件中查找标记为待翻译的字符串，并将其更新到指定的.pot模板文件中。
检查生成的新.pot文件，确认其中包含了您预期的新增和修改过的字符串。
接下来，将这个更新后的模板文件合并到各个语言的.po文件中，这样翻译团队就可以在这些文件中添加或更新对应的语言翻译：
```
pybabel update -i app/locales/local_all.pot -d app/locales/
```
这个命令会自动将新内容添加到相应语言目录下已有的.po文件中，并保持旧有翻译的完整性。
当翻译完成后，编译.po文件为二进制.mo文件，供应用程序在运行时加载使用：
```
pybabel compile -f -d app/locales/
```
通过以上步骤，您的国际化(i18n)流程就能跟上项目的开发进度，始终保持最新的翻译资源可用。
### 注意！语言包更新后重启服务更新。
-------------------------------------------
## 联系作者:
邮箱：86013060@qq.com
微信：zhanfish_dev
-------------------------------------------