Penpot 项目教程

1. 项目目录结构及介绍

Penpot 是一个开源的设计和原型制作工具，其项目目录结构如下：

penpot/
├── backend/
├── common/
├── docker/
├── experiments/
├── exporter/
├── frontend/
├── sample_media/
├── .cljfmt.edn
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .gitpod.yml
├── .travis.yml
├── .yarnrc.yml
├── CHANGES.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
├── THANKYOU.md
├── deps.edn
├── manage.sh
├── package.json
├── tracebitmap.txt
├── yarn.lock

目录结构介绍

• backend/：包含 Penpot 的后端代码，主要使用 Clojure 编写。
• common/：包含项目中通用的代码和工具。
• docker/：包含 Docker 相关的配置文件，用于项目的容器化部署。
• experiments/：包含一些实验性的代码和功能。
• exporter/：包含导出功能的代码，用于将设计导出为不同的格式。
• frontend/：包含 Penpot 的前端代码，主要使用 ClojureScript 编写。
• sample_media/：包含一些示例媒体文件，用于测试和演示。
• .cljfmt.edn：Clojure 代码格式化配置文件。
• .editorconfig：编辑器配置文件，用于统一代码风格。
• .gitattributes：Git 属性配置文件。
• .gitignore：Git 忽略文件配置。
• .gitpod.yml：Gitpod 配置文件，用于云端开发环境。
• .travis.yml：Travis CI 配置文件，用于持续集成。
• .yarnrc.yml：Yarn 配置文件。
• CHANGES.md：项目变更日志。
• CONTRIBUTING.md：贡献指南。
• LICENSE：项目许可证。
• README.md：项目介绍和使用说明。
• SECURITY.md：安全相关信息。
• THANKYOU.md：感谢贡献者。
• deps.edn：Clojure 依赖管理文件。
• manage.sh：项目管理脚本。
• package.json：Node.js 项目配置文件。
• tracebitmap.txt：位图跟踪文件。
• yarn.lock：Yarn 锁定文件，用于确保依赖版本一致性。

2. 项目启动文件介绍

Penpot 项目的启动文件主要集中在 backend/ 和 frontend/ 目录中。以下是主要的启动文件：

后端启动文件

• backend/src/penpot/core.clj：这是 Penpot 后端的主要入口文件，包含了应用程序的启动逻辑。

前端启动文件

• frontend/src/penpot/core.cljs：这是 Penpot 前端的主要入口文件，包含了前端应用程序的启动逻辑。

3. 项目配置文件介绍

Penpot 项目的配置文件主要用于配置项目的运行环境和行为。以下是主要的配置文件：

环境配置

• .env：用于配置环境变量，例如数据库连接信息、API 密钥等。

构建配置

• package.json：Node.js 项目的配置文件，包含了项目的依赖和构建脚本。
• yarn.lock：Yarn 锁定文件，确保依赖版本一致性。

代码风格配置

• .cljfmt.edn：Clojure 代码格式化配置文件。
• .editorconfig：编辑器配置文件，用于统一代码风格。

持续集成配置

• .travis.yml：Travis CI 配置文件，用于持续集成。

Docker 配置

• docker/docker-compose.yml：Docker Compose 配置文件，用于定义和运行多容器 Docker 应用程序。

通过以上配置文件，可以灵活地配置和管理 Penpot 项目的运行环境和行为。