Flask Volt Dashboard 项目教程

Flask Volt Dashboard 项目教程

flask-volt-dashboard Flask Bootstrap 5 - Volt Dashboard | AppSeed 项目地址: https://gitcode.com/gh_mirrors/fl/flask-volt-dashboard

1. 项目目录结构及介绍

Flask Volt Dashboard 项目的目录结构如下：

< PROJECT ROOT >
|
|-- apps/
|   |-- home/  # 提供HTML文件的简单应用
|   |   |-- routes.py  # 定义应用路由
|   |-- authentication/  # 处理认证路由（登录和注册）
|   |   |-- routes.py  # 定义认证路由
|   |   |-- models.py  # 定义模型
|   |   |-- forms.py  # 定义认证表单（登录和注册）
|   |-- static/
|   |   |-- <css, JS, images>  # CSS文件、JavaScript文件和图片
|   |-- templates/  # 用于渲染页面的模板
|   |   |-- includes/  # HTML片段和组件
|   |   |   |-- navigation.html  # 顶部菜单组件
|   |   |   |-- sidebar.html  # 侧边栏组件
|   |   |   |-- footer.html  # 应用页脚
|   |   |   |-- scripts.html  # 所有页面通用的脚本
|   |   |-- layouts/  # 主页面
|   |   |   |-- base-fullscreen.html  # 用于认证页面
|   |   |   |-- base.html  # 用于通用页面
|   |   |-- accounts/  # 认证页面
|   |   |   |-- login.html  # 登录页面
|   |   |   |-- register.html  # 注册页面
|   |   |-- home/  # UI Kit页面
|   |   |   |-- index.html  # 首页
|   |   |   |-- 404-page.html  # 404页面
|   |   |   |-- *  # 其他页面
|   |-- config.py  # 应用配置
|   |-- __init__.py  # 初始化应用
|
|-- requirements.txt  # 应用依赖
|-- .env  # 通过环境注入配置
|-- run.py  # 启动应用 - WSGI网关

2. 项目启动文件介绍

项目的启动文件是 run.py，该文件是 WSGI 网关，用于启动 Flask 应用。启动应用的命令如下：

$ flask run

或者使用 HTTPS 启动：

$ flask run --cert=adhoc

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个部分：

3.1 config.py

config.py 文件包含了应用的基本配置，如开发环境和生产环境的配置。

3.2 .env

.env 文件用于通过环境变量注入配置。以下是一些常见的环境变量：

• DEBUG: 如果设置为 True，应用以开发模式运行；生产环境中应设置为 False。
• ASSETS_ROOT: 用于管理静态资源的路径，默认值为 /static/assets。
• GITHUB_ID 和 GITHUB_SECRET: 用于通过 GitHub 进行 OAuth 认证。

3.3 requirements.txt

requirements.txt 文件列出了应用的所有依赖包，可以通过以下命令安装：

$ pip3 install -r requirements.txt

3.4 docker-compose.yml

docker-compose.yml 文件用于定义 Docker 容器的服务配置，可以通过以下命令启动应用：

$ docker-compose up --build

启动后，访问 http://localhost:5085 即可查看应用。

flask-volt-dashboard Flask Bootstrap 5 - Volt Dashboard | AppSeed 项目地址: https://gitcode.com/gh_mirrors/fl/flask-volt-dashboard