AMS 使用文档

# 创建项目

在 AMS 的使用过程中, 后端往往需要提一些定制化的需求. 为了满足这类型的需求, 我们需要明确:

  1. 该需求当前组件或者文档已经有解决方案
  2. 该需求我们是否可以通过编写一个 DEMO JSON 并作为文档的形式回应后端提出的需求
  3. 该需求如果需要开发, 那么请确定清楚该需求所需开发的组件粒度, 目前粒度分为 组件, 场景, 页面. 我们推荐提供 组件 或 场景 的粒度, 这是因为往往这样的粒度能够很好的复用.

除了第一点以外, 我们仍需要创建一个 文件夹作为项目 沙箱空间使用, 而文件夹命名请根据后端具体项目命名决定.

命名如:

买量后台 => cost-per-buy, 即使用 cost-per-buy 作为文件夹命名即可, 如重复性项目请考虑使用 cost-per-buy--20200501 作为文件名

# 创建项目文件夹

请确保 AMS 开发项目已通过 git clone, 使用 yarn / npm 完成安装.

贡献者需要在 src/.projects/ 下创建项目, 如 中秋活动, 创建目录为: src/.projects/mid-autumn--20200907. 在该文件夹下要求结构如下

components        # 组件
pages             # 页面
scenarios         # 场景
utils             # 工具类
services          # 服务
action            # 操作
1
2
3
4
5
6

我们不难看出, 文件夹命名与 src/* 下文件夹组织结构一致. 在一定程度上, 这样的设计是把当前项目作为一个小应用低耦合独立存在. 故请遵循以下原则:

以 src/.projects/mid-autumn--20200907 中秋活动 项目为例

  1. 项目可以使用 src/* 下 utils, action, store, pages, scenarios 等引用, 但禁止引用 src/.projects/ 文件夹下的其他项目.
  2. 禁止修改除 src/.projects/mid-autumn--20200907 项目外的任何内容, 这是确保每一个新建的项目都是独立且无污染的. 如果确实有这方面的需求, 请联系 AMS 的作者
  3. 针对第二点, 对于常用的项目级的 components 或 scenarios, 我们可以贡献代码并完善 AMS 基础建设, 贡献的方式目前可以通过代码拷贝或 git 的 merge/pull request 进行.

未完待续...

←