Pharos 设计系统启动与配置教程

1. 项目目录结构及介绍

Pharos 是 JSTOR 的设计系统，旨在为好奇心旺盛的用户创造连贯、支持和美丽的使用体验。该项目包含了多个包和配置文件，其目录结构大致如下：

pharos/
├── packages/                    # 存放 Pharos 组件库
│   ├── @ithaka/pharos/
│   ├── @ithaka/pharos-cli/
│   └── @ithaka/pharos-site/
├── scripts/                     # 脚本文件，用于构建和测试等
├── src/                         # 源代码目录
├── .circleci/                   # CircleCI 配置文件
├── .eslintrc.js                 # ESLint 配置文件
├── .gitignore                   # Git 忽略文件
├── .prettierrc.js               # Prettier 配置文件
├── .stylelintrc.js              # Stylelint 配置文件
├── .yarnrc.yml                  # Yarn 配置文件
├── CHANGELOG.md                 # 更改日志
├── CONTRIBUTING.md              # 贡献指南
├── LICENSE                      # MIT 许可证
├── README.md                    # 项目自述文件
└── yarn.lock                    # Yarn 锁定文件

2. 项目的启动文件介绍

项目的启动主要是通过 yarn 或 npm 来执行相应的脚本。通常情况下，项目的入口文件可能为 src/index.ts 或 src/index.js。以下是一个简单的启动过程：

• 安装依赖：yarn install 或 npm install
• 启动开发服务器：yarn start 或 npm start（具体命令可能因项目配置不同而有所变化）

在 package.json 文件中，通常会定义一些脚本，例如：

"scripts": {
  "start": "pharos-cli serve",
  "build": "pharos-cli build",
  "test": "pharos-cli test"
}

这些脚本会调用 pharos-cli 工具来启动开发服务器、构建项目或执行测试。

3. 项目的配置文件介绍

项目的配置文件用于定义项目构建、测试和代码风格等方面的规则。

• .eslintrc.js：ESLint 配置文件，用于定义代码质量和风格规则。
• .prettierrc.js：Prettier 配置文件，用于定义代码格式化规则。
• .stylelintrc.js：Stylelint 配置文件，用于定义 CSS 样式规则。
• .yarnrc.yml：Yarn 配置文件，用于配置 Yarn 的行为。

每个配置文件都有其特定的作用和配置项，可以根据项目需求和团队规范进行相应的调整。

本文档旨在提供一个基础的启动和配置指南。更多详细信息和具体用法，请参考项目官方文档和教程。