Skip to content

Latest commit

 

History

History
21 lines (14 loc) · 2.49 KB

DESIGN.md

File metadata and controls

21 lines (14 loc) · 2.49 KB

DESIGN

术语

  • 组件库:Kawa Resume 提供的组件库物料,包括用户头像、用户内容列表和用户实习经历等 React 组件;
  • 布局预设:Kawa Resume 提供的布局预设,包括简历的基本布局和简历的基本样式。布局预设是 React 组件,由 Kawa Resume 的组件库组成,包含完整的简历页面设计;
  • 主题预设:Kawa Resume 提供的主题预设,是 JavaScript 对象,类似一个 JSON 数据,它应当包括所有组件库的样式,如配色风格、字体偏好等;
  • 用户内容:用户在 Kawa Resume 中填写的内容,包括用户的基本信息、用户的教育经历、用户的实习经历等;
  • 卡哇简历:Kawa Resume 提供的构建产出,是一个完整的生产环境简历页面,用户可以选择产出的产物格式,如原生的 HTML5、PDF和各类图片格式等。

设计哲学

  • 元编程模式:我们将所有部分(包括组件库、布局预设和主题预设等)细粒度地拆分开来,每一个部分都是独立的库,这使得 Kawa Resume 可以在任何场景中工作,例如用户可以通过直接引入@kawafe/core@kawafe/components等来调用卡哇核心和卡哇组件库,也可以使用@kawafe/cli来直接调用卡哇简历的上层接口,同时也可以使用我们的 Kawa 网页端来基于低代码模式使用卡哇简历;
  • 预设优先:我们应当尽力避免创建任何被固定的、无法修改和定制的代码框架,我们应当使用预设模式来保证预设在我们的框架中是“第一等公民”,即通过配置预设(布局和样式)来弹性的组成一个完整的简历;
  • 用户优先:我们的项目是面向用户的,所以我们的接口应当是用户友好和用户优先的,我们应当尽力让用户尽可能可以微调卡哇简历中的每一处细节工作。

工作流程

首先向卡哇核心给入用户内容,随后通过选择我们预先提供的布局预设(@kawafe/layout)和主题预设(@kawafe/theme),来构建一份完整的定制化简历。

我们为用户提供多种使用方式,预设除了可以使用我们提供的预设之外,用户也可以继承我们的预设,通过基于已有预设微调的方式来生成一份定制化的简历。用户也可以自行完成所有工作,通过使用我们提供的组件库(@kawafe/components)来构建布局和主题预设。这样的功能面向具有一定前端开发经验的用户。