# amis

**Repository Path**: yl88888/amis

## Basic Information

- **Project Name**: amis
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-12
- **Last Updated**: 2025-05-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
  <p>
    <img width="284" src="https://github.com/baidu/amis/raw/master/examples/static/logo.png">
  </p>

[文档（国内）](https://aisuda.bce.baidu.com/amis/) |
[文档（国外）](https://baidu.github.io/amis/) |
[可视化编辑器](https://aisuda.github.io/amis-editor-demo/) |
[amis-admin](https://github.com/aisuda/amis-admin) |
[爱速搭](https://aisuda.baidu.com/)

</div>

<div align="center">
  如流群：3395342 |
  如流群2：5511067|
</div>

<div align="center">

![build](https://img.shields.io/github/actions/workflow/status/baidu/amis/gh-pages.yml)
![license](https://img.shields.io/github/license/baidu/amis.svg)
![version](https://img.shields.io/npm/v/amis)
![language](https://img.shields.io/github/languages/top/baidu/amis)
[![codecov](https://codecov.io/gh/baidu/amis/branch/master/graph/badge.svg?token=9LwimHGoE5)](https://codecov.io/gh/baidu/amis)
![last](https://img.shields.io/github/last-commit/baidu/amis.svg)

</div>

前端低代码框架，通过 JSON 配置就能生成各种后台页面，极大减少开发成本，甚至可以不需要了解前端。

## 开发指南

以下是参与开发 amis 才需要看的，使用请看前面的文档。

> 如果 github 下载慢可以使用 [gitee](https://gitee.com/baidu/amis) 上的镜像。

推荐使用 node 12/14/16。npm 7+， 因为用到了 workspaces 功能。

```bash
磊2025-05-12修改本条内容
# 全局安装 cnpm，并指定使用淘宝 npm 镜像源。
npm install -g cnpm --registry=https://registry.npmmirror.com： 

# 安装项目 npm 依赖，在 node 12 下会有报错但不影响正常使用。
cnpm i --legacy-peer-deps

# 使用 cnpm 安装 react-is 依赖。
cnpm install react-is： 

# 使用 cnpm 安装 cropperjs 依赖。
cnpm install cropperjs

# 使用 cnpm 安装 tinycolor2 依赖。
cnpm install tinycolor2

#使用 cnpm 安装 @types/tinycolor2 依赖，并将其保存为开发依赖（devDependencies）。
cnpm install @types/tinycolor2 --save-dev

# 启动项目，等编译结束后通过 http://127.0.0.1:8888/examples/pages/simple 访问。
npm start
```

如果是开发编辑器，需要访问 `http://127.0.0.1:8888/packages/amis-editor/`

```bash
#如果cnpm执行不了
先检查 cnpm -version   如果能显示版本号不用配置环境变量
#以管理员身份运行 PowerShell：

在开始菜单中搜索 "PowerShell"。
右键点击 "Windows PowerShell"，然后选择 "以管理员身份运行"。
查看当前的执行策略：

在 PowerShell 中运行以下命令：

#命令  Get-ExecutionPolicy
如果输出为 Restricted，说明执行策略限制了脚本的运行。
修改执行策略：

运行以下命令，修改执行策略：

#命令 Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Set-ExecutionPolicy： 修改执行策略的命令。
-ExecutionPolicy RemoteSigned： 设置执行策略为 RemoteSigned，允许运行本地脚本，但要求从 Internet 下载的脚本必须经过签名。 这是一个相对安全的选项。
-Scope CurrentUser： 将执行策略的修改应用于当前用户。
#注意： 你可能需要确认修改执行策略。 输入 A (Yes to All)，然后按 Enter 键。

验证执行策略是否修改成功：

再次运行以下命令，查看当前的执行策略：

#命令 Get-ExecutionPolicy
#正常到这步就结束了，下面的就不要看了
如果输出为 RemoteSigned，说明执行策略修改成功。
其他执行策略选项：

除了 RemoteSigned，还有其他执行策略选项：

Unrestricted： 允许运行所有脚本。 不建议使用此选项，因为它存在安全风险。
AllSigned： 只允许运行经过签名的脚本。
Bypass： 不阻止任何内容，并且没有警告或提示。
选择 RemoteSigned 是一个比较平衡的选择，既允许你运行本地脚本，又可以防止运行恶意脚本。

详细步骤：

以管理员身份运行 PowerShell。
运行 Get-ExecutionPolicy 命令，查看当前的执行策略。
如果当前的执行策略不是 RemoteSigned，运行 Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser 命令修改执行策略。
重新启动 PowerShell。
完成这些步骤后，你应该可以成功运行 cnpm i --legacy-peer-deps 命令了。
```



### 测试

> 注意：本地修改代码后，执行测试用例（`npm test --workspaces`）之前需要先执行`npm run build`完成编译，因为 jest 并不支持 TypeScript

```bash
# 安装依赖
npm i --legacy-peer-deps

# 执行构建
npm run build

# 执行测试用例
npm test --workspaces

# 测试某个用例
# <spec-name>为用例名称，比如inputImage
npm test --workspace amis -- -t <spec-name>

# 运行某个单测文件
./node_modules/.bin/jest packages/amis/__tests__/renderers/Form/buttonToolBar.test.tsx

# 运行某个单测文件里的某个例子
./node_modules/.bin/jest packages/amis/__tests__/renderers/Form/buttonToolBar.test.tsx -t 'Renderer:button-toolbar'

# 查看测试用例覆盖率
npm run coverage

# 更新 snapshot
npm run update-snapshot

# 更新单个 snapshot
# <spec-name>为用例名称，比如inputImage
npm run update-snapshot --workspace amis -- -t  <spec-name>
```

### 发布版本

```bash
# 发布内部 registry
npm run publish

# 发布外网环境
# 先通过一下命令设置版本号
npm run version
npm run release
```

### 如何贡献

请使用分支开发，首先创建分支

    git checkout -b feat-xxx

开发提交后使用 `git push --set-upstream origin feat-xxx` 创建远程分支。

然后通过系统提示的 https://github.com/xxx/amis/pull/new/feat-xxx 链接来提交 PR。

请采用 typescript 编写，所有合理的改动、新的公用渲染器、用例或者文档的提交都会被接收。

## 贡献者

<a href="https://github.com/baidu/amis/graphs/contributors"><img src="https://opencollective.com/amis/contributors.svg?width=890" /></a>

## 低代码平台

amis 只能实现前端低代码，如果需要完整的低代码平台推荐使用[爱速搭](https://aisuda.baidu.com/)。