首页
/ Yoga 项目启动与配置教程

Yoga 项目启动与配置教程

2025-04-28 02:00:40作者:丁柯新Fawn

1. 项目目录结构及介绍

Yoga 项目的目录结构如下所示:

yoga/
├── .gitignore
├── README.md
├── config
│   ├── default.py
│   └── prod.py
├── main
│   ├── __init__.py
│   ├── app.py
│   └── models.py
├── static
│   └── css
│       └── style.css
├── templates
│   └── index.html
└── requirements.txt

以下是各目录和文件的简要介绍:

  • .gitignore:用于指定 Git 忽略跟踪的文件和目录。
  • README.md:项目的说明文件,包含项目的介绍、安装和使用说明。
  • config:存放项目的配置文件。
    • default.py:默认配置文件,用于开发环境。
    • prod.py:生产环境配置文件,用于优化生产环境下的配置。
  • main:项目的主目录,包含项目的核心代码。
    • __init__.py:初始化 Python 模块。
    • app.py:项目的主启动文件。
    • models.py:定义项目中的数据模型。
  • static:存放静态文件,如 CSS、JavaScript 和图片等。
    • css:存放 CSS 文件。
      • style.css:项目的样式文件。
  • templates:存放 HTML 模板文件。
    • index.html:项目的主页模板。
  • requirements.txt:项目依赖文件,用于记录项目所依赖的 Python 包。

2. 项目的启动文件介绍

项目的启动文件为 main/app.py,以下是该文件的主要内容:

from flask import Flask
from models import db

app = Flask(__name__)

app.config.from_object('config.default')

db.init_app(app)

@app.route('/')
def index():
    return 'Hello, Yoga!'

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

该文件首先导入了 Flask 和项目中的数据库模型 db。然后创建了一个 Flask 应用实例 app,并从 config/default.py 文件中加载默认配置。接着初始化了数据库应用。定义了一个路由 /,当访问这个路由时会返回 "Hello, Yoga!" 字符串。最后,如果该文件作为主程序运行,则启动 Flask 应用。

3. 项目的配置文件介绍

项目的配置文件分为开发环境配置文件 config/default.py 和生产环境配置文件 config/prod.py

开发环境配置文件(config/default.py)

import os

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

class Config:
    SECRET_KEY = 'your_secret_key'
    SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'data.db')
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    FLASK_APP = 'main.app'

开发环境配置文件中设置了 Flask 应用的密钥 SECRET_KEY,数据库的连接字符串 SQLALCHEMY_DATABASE_URI,以及关闭 SQLALCHEMY 的跟踪修改功能 SQLALCHEMY_TRACK_MODIFICATIONS

生产环境配置文件(config/prod.py)

from config.default import Config

class Config(Config):
    SQLALCHEMY_DATABASE_URI = 'mysql://user:password@localhost/db_name'

生产环境配置文件继承自开发环境配置文件,并重写了数据库的连接字符串,以适应生产环境下的数据库配置。请根据实际生产环境替换 userpassworddb_name

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