ProtonMail 设计系统教程

ProtonMail 设计系统教程

design-systemDesign system for new Proton project项目地址:https://gitcode.com/gh_mirrors/designsyst/design-system

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

design-system/
├── docs/
│   ├── README.md
│   └── ...
├── src/
│   ├── components/
│   │   ├── Button/
│   │   │   ├── Button.tsx
│   │   │   └── Button.test.tsx
│   │   └── ...
│   ├── styles/
│   │   ├── global.css
│   │   └── ...
│   ├── utils/
│   │   ├── index.ts
│   │   └── ...
│   ├── index.ts
│   └── ...
├── public/
│   ├── index.html
│   └── ...
├── package.json
├── tsconfig.json
└── ...

目录结构介绍

• docs/: 包含项目的文档文件，如 README.md 等。
• src/: 项目的源代码目录，包含组件、样式、工具函数等。
  • components/: 存放项目的各个组件，每个组件通常包含其源文件和测试文件。
  • styles/: 存放全局样式文件。
  • utils/: 存放工具函数和辅助代码。
  • index.ts: 项目的入口文件。
• public/: 存放静态资源文件，如 index.html。
• package.json: 项目的配置文件，包含依赖、脚本等信息。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

src/index.ts

这是项目的入口文件，负责初始化应用并渲染根组件。通常包含以下内容：

import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(<App />, document.getElementById('root'));

启动流程

1. 加载依赖: 项目启动时，首先加载 React 和 ReactDOM 等依赖库。
2. 渲染应用: 通过 ReactDOM.render 方法将 App 组件渲染到 index.html 中的 root 元素。

3. 项目的配置文件介绍

package.json

这是 Node.js 项目的配置文件，包含项目的元数据、依赖、脚本等信息。

{
  "name": "design-system",
  "version": "1.0.0",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2",
    "react-scripts": "4.0.3"
  },
  "devDependencies": {
    "@types/react": "^17.0.3",
    "@types/react-dom": "^17.0.3",
    "typescript": "^4.2.3"
  }
}

主要配置项

• scripts: 定义了项目的脚本命令，如 start、build、test 等。
• dependencies: 项目的生产环境依赖。
• devDependencies: 项目的开发环境依赖。

tsconfig.json

这是 TypeScript 的配置文件，用于配置 TypeScript 编译器的行为。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "**/*.spec.ts"]
}

主要配置项

• compilerOptions: 配置 TypeScript 编译器的选项，如目标 ECMAScript 版本、模块系统等。
• include: 指定需要编译的文件或目录。
• exclude: 指定不需要编译的文件或目录。

design-systemDesign system for new Proton project项目地址:https://gitcode.com/gh_mirrors/designsyst/design-system