canonical.com 的安装和配置教程

项目基础介绍

canonical.com 是一个开源项目，它是 Canonical Ltd. 公司的官方网站的新版本代码库。这个项目使用 Flask 框架构建，并且集成了多个 Canonical 网站共享的功能模块，例如 base-flask-extension。该项目的内容遵循 Creative Commons Attribution-ShareAlike 4.0 国际许可协议，而底层代码则采用 LGPLv3 许可。

该项目主要用于展示 Canonical 的产品、服务和相关信息，是一个典型的 web 应用程序。

主要编程语言

• HTML
• Python
• JavaScript
• SCSS
• Shell
• TypeScript

项目使用的关键技术和框架

• Flask：一个轻量级的 Web 应用框架。
• base-flask-extension：一个基础 Flask 扩展模块，用于提供共享功能。
• dotrun snap：一个用于本地运行的工具。

项目安装和配置的准备工作

在开始安装和配置 canonical.com 项目之前，请确保您的系统中已经安装了以下依赖：

• Python
• Flask
• Git
• Node.js 和 npm（用于前端资源构建）
• dotrun（可选，用于本地运行）

您还需要准备一个有效的 Greenhouse API Key，用于 careers 部分的本地开发。

安装步骤

1. 克隆项目

   从 GitHub 上克隆 canonical.com 项目到本地：

   git clone https://github.com/canonical/canonical.com.git
   cd canonical.com
   

2. 设置环境变量

   在项目根目录下创建一个 .env 文件，并添加您的 Greenhouse API Key：

   touch .env
   echo "HARVEST_API_KEY=your_greenhouse_api_key" > .env
   

3. 安装 Python 依赖

   使用 pip 安装项目所需的 Python 包：

   pip install -r requirements.txt
   

4. 安装前端依赖

   进入 webapp 目录，并使用 npm 安装前端依赖：

   cd webapp
   npm install
   

5. 运行项目

   使用 dotrun 或者 Flask 内置的服务器来启动项目：

   使用 dotrun：

   dotrun
   

   使用 Flask：

   flask run
   

   项目将启动并在本地服务器上运行，默认地址为 http://localhost:8002。

6. 开发与测试

   在开发过程中，您可以修改文件，服务器将自动重新加载以反映更改。要测试您的更改，只需在浏览器中刷新页面即可。

以上步骤完成之后，您应该能够在本地成功运行 canonical.com 项目，并进行开发和测试工作。