首页
/ Flask-Admin-Dashboard 项目教程

Flask-Admin-Dashboard 项目教程

2024-09-16 13:06:02作者:鲍丁臣Ursa

1. 项目目录结构及介绍

Flask-Admin-Dashboard/
├── app.py
├── config.py
├── flask_admin/
│   ├── __init__.py
│   ├── helpers.py
│   ├── model.py
│   ├── form.py
│   ├── form/
│   │   ├── rules.py
│   │   ├── fields.py
│   │   ├── upload.py
│   ├── tools.py
│   ├── actions.py
│   ├── contrib/
│   │   ├── sqla/
│   │   │   ├── fields.py
│   │   ├── peewee/
│   │   ├── pymongo/
│   │   ├── fileadmin/
│   ├── model_template/
├── requirements.txt
├── sample_db.sqlite
├── static/
├── templates/
├── screenshots/
├── LICENSE
├── README.md
└── .gitignore

目录结构介绍

  • app.py: 项目的启动文件。
  • config.py: 项目的配置文件。
  • flask_admin/: 包含 Flask-Admin 扩展的相关文件和模块。
    • __init__.py: 初始化 Flask-Admin 扩展。
    • helpers.py: 包含一些辅助函数。
    • model.py: 处理与数据库模型相关的逻辑。
    • form.py: 处理表单相关的逻辑。
    • form/: 包含表单相关的子模块。
      • rules.py: 表单验证规则。
      • fields.py: 自定义表单字段。
      • upload.py: 文件上传处理。
    • tools.py: 包含一些工具函数。
    • actions.py: 处理批量操作。
    • contrib/: 包含与其他数据库后端集成的模块。
      • sqla/: SQLAlchemy 集成。
      • peewee/: Peewee 集成。
      • pymongo/: PyMongo 集成。
      • fileadmin/: 文件管理集成。
    • model_template/: 模型模板。
  • requirements.txt: 项目依赖文件。
  • sample_db.sqlite: 示例 SQLite 数据库文件。
  • static/: 静态文件目录,包含 CSS、JavaScript 等文件。
  • templates/: 模板文件目录,包含 HTML 模板文件。
  • screenshots/: 项目截图目录。
  • LICENSE: 项目许可证文件。
  • README.md: 项目说明文件。
  • .gitignore: Git 忽略文件配置。

2. 项目启动文件介绍

app.py

app.py 是 Flask-Admin-Dashboard 项目的启动文件。它包含了 Flask 应用的初始化、路由配置、数据库连接等核心逻辑。

from flask import Flask
from flask_admin import Admin
from flask_admin.contrib.sqla import ModelView
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config.from_object('config')

db = SQLAlchemy(app)

admin = Admin(app, name='Admin Dashboard', template_mode='bootstrap3')

# 添加模型视图
from models import User, Role
admin.add_view(ModelView(User, db.session))
admin.add_view(ModelView(Role, db.session))

if __name__ == '__main__':
    app.run(debug=True)

主要功能

  • Flask 应用初始化: 创建 Flask 应用实例 app
  • 配置加载: 从 config.py 文件中加载配置。
  • 数据库初始化: 初始化 SQLAlchemy 数据库连接。
  • Flask-Admin 初始化: 初始化 Flask-Admin 并添加模型视图。
  • 启动应用: 在调试模式下启动 Flask 应用。

3. 项目配置文件介绍

config.py

config.py 文件包含了 Flask-Admin-Dashboard 项目的配置信息,包括数据库连接、密钥、调试模式等。

import os

basedir = os.path.abspath(os.path.dirname(__file__))

class Config(object):
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'you-will-never-guess'
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or \
        'sqlite:///' + os.path.join(basedir, 'sample_db.sqlite')
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    DEBUG = True

主要配置项

  • SECRET_KEY: Flask 应用的密钥,用于加密会话等敏感数据。
  • SQLALCHEMY_DATABASE_URI: 数据库连接字符串,默认使用 SQLite 数据库。
  • SQLALCHEMY_TRACK_MODIFICATIONS: 是否跟踪数据库修改,默认关闭以提高性能。
  • DEBUG: 是否启用调试模式,默认启用。

通过这些配置项,可以灵活地调整项目的运行环境和行为。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.94 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
554
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
887
394
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
512