Chromatix 项目启动与配置教程

1. 项目的目录结构及介绍

Chromatix 项目采用以下目录结构：

chromatix/
├── .gitignore          # 指定在版本控制中忽略的文件和目录
├── .env.example        # 环境变量示例文件
├── README.md           # 项目说明文件
├── requirements.txt    # 项目依赖的 Python 包列表
├── config/             # 配置文件目录
│   ├── base.py         # 基础配置
│   ├── dev.py          # 开发环境配置
│   └── prod.py         # 生产环境配置
├── chromatix/          # 项目核心代码目录
│   ├── __init__.py     # 初始化文件
│   ├── app.py          # 应用启动文件
│   └── ...             # 其他模块文件
├── migrations/         # 数据库迁移脚本目录
└── tests/              # 测试代码目录

• .gitignore：指定在版本控制中应该忽略的文件和目录，如编译生成的临时文件、环境配置文件等。
• .env.example：提供环境变量配置的示例，用于开发环境的配置。
• README.md：项目的详细说明，包括项目介绍、安装步骤、使用说明等。
• requirements.txt：列出项目所依赖的 Python 包，便于环境部署。
• config/：存放配置文件，包括基础配置和不同环境的配置。
• chromatix/：项目核心代码所在目录，包括应用启动文件和其他模块。
• migrations/：存放数据库迁移脚本，用于版本控制。
• tests/：存放测试代码，确保项目功能的正确性。

2. 项目的启动文件介绍

项目的启动文件位于 chromatix/chromatix/app.py。以下是启动文件的基本结构：

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

# 初始化 Flask 应用
app = Flask(__name__)

# 配置数据库
app.config.from_object('config.base')
app.config.from_envvar('CHROMATIX_SETTINGS', silent=True)

# 初始化数据库
db = SQLAlchemy(app)

# 定义路由和视图函数
@app.route('/')
def index():
    return "Hello, Chromatix!"

# 启动应用
if __name__ == '__main__':
    app.run()

该文件负责初始化 Flask 应用、配置数据库连接，并定义了基本的路由和视图函数。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，包括以下文件：

• base.py：基础配置文件，定义了项目的通用配置。
• dev.py：开发环境配置文件，通常包括调试模式和数据库配置。
• prod.py：生产环境配置文件，配置项会更加注重性能和安全性。

base.py 示例：

class BaseConfig:
    SECRET_KEY = 'your_secret_key'
    SQLALCHEMY_DATABASE_URI = 'sqlite:///chromatix.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    # 其他基础配置...

dev.py 示例：

from base import BaseConfig

class DevelopmentConfig(BaseConfig):
    DEBUG = True
    SQLALCHEMY_DATABASE_URI = 'mysql://user:password@localhost/chromatix'
    # 其他开发环境配置...

prod.py 示例：

from base import BaseConfig

class ProductionConfig(BaseConfig):
    DEBUG = False
    SQLALCHEMY_DATABASE_URI = 'mysql://user:password@prod-server/chromatix'
    # 其他生产环境配置...

在启动应用时，可以通过环境变量 CHROMATIX_SETTINGS 指定使用哪个配置文件。