Canonical.com 项目启动与配置教程

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

Canonical.com 项目是一个基于 Flask 框架的开源网站项目。项目的目录结构如下：

• /.gitignore：指定 Git 忽略的文件和目录。
• /Dockerfile：用于构建 Docker 容器的配置文件。
• /README.md：项目的说明文档。
• /requirements.txt：项目依赖的 Python 包列表。
• /templates：包含所有 HTML 模板的目录。
• /static：包含 CSS、JavaScript 和图片等静态文件的目录。
• /webapp：网站的主要逻辑和 Flask 应用的代码目录。
  • /webapp/__init__.py：初始化 Flask 应用。
  • /webapp/views.py：处理路由和视图的函数。
  • /webapp/models.py：定义数据库模型的文件。
  • /webapp/forms.py：定义表单的文件。
• /tests：测试用例的目录。
• /scripts：脚本文件的目录。
• /run：运行项目的脚本。
• /navigation.yaml：配置网站导航结构的文件。
• /secondary-navigation.yaml：配置网站次级导航结构的文件。
• 其他配置和脚本文件。

2. 项目的启动文件介绍

项目的启动文件是 run 脚本。运行以下命令可以启动 Flask 应用：

./run

启动后，网站将默认在 http://localhost:8002 地址上运行。如果需要修改端口或地址，可以在 run 脚本中进行相应的配置。

3. 项目的配置文件介绍

项目的主要配置文件如下：

• /webapp/__init__.py：在这个文件中，你可以配置 Flask 应用的基本设置，例如数据库连接、密钥等。
• .env：环境变量配置文件。在这个文件中，你可以设置一些环境变量，例如 FLASK_APP、FLASK_ENV、DATABASE_URL 等。对于 /careers 部分的本地开发，你还需要添加 HARVEST_API_KEY 环境变量。
• /navigation.yaml 和 /secondary-navigation.yaml：这些文件用于配置网站的主导航和次级导航结构。在这里，你可以定义菜单项和它们的链接。
• 其他配置文件：根据项目需求，可能还有其他特定的配置文件，例如 /postcss.config.js 用于配置 PostCSS。

确保在启动项目前，所有必要的配置文件都已经正确设置。这将有助于确保项目能够顺利运行。