Skip to content

Commit

Permalink
chore: update
Browse files Browse the repository at this point in the history
  • Loading branch information
stbui committed Sep 7, 2019
1 parent 6502373 commit d9c849b
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 18 deletions.
27 changes: 10 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,24 @@
- 提炼 CRUD 容器组件,快速开始前端开发
- 基于 Ant Design 组件布局
- 提炼后台应用的典型页面和场景
- 提供 dataProvider 来适配各种数据规范
- 提供 dataProvider 来处理各种数据规范

# 架构

![架构](docs/prophet.svg)
![架构](docs/prophet.png)

## 起步

```bash
npm install prophet-core
npm install prophet-core@latest prophet-antd@latest prophet-data-json-server@latest
```

```js
import { Prophet, Resource } from 'prophet-core';
import { Layout } from 'prophet-antd';
import dataJsonServer from 'prophet-data-json-server';

<Prophet dataProvider={dataJsonServer('http://127.0.0.1:3001')}>
<Prophet layout={Layout} dataProvider={dataJsonServer('http://127.0.0.1:3001')}>
<Resource
name="users"
list={props => <div>list</div>}
Expand All @@ -36,16 +37,8 @@ import dataJsonServer from 'prophet-data-json-server';

## Packages

| Package | Docs | Description |
| -------------------------------------------------------- | ---- | ----------- |
| [`prophet-core`](/packages/core) | | |
| [`prophet-antd`](/packages/antd) | | |
| [`prophet-data-json-server`](/packages/data-json-server) | | |

## dev

```bash
npm install
npm run build
npm run demo
```
| Package | Docs | Description |
| -------------------------------------------------------- | ---- | ----------------- |
| [`prophet-core`](/packages/core) | | 底层组件的封装 |
| [`prophet-antd`](/packages/antd) | | antd UI 实现 |
| [`prophet-data-json-server`](/packages/data-json-server) | | REST 接口规范实现 |
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- 提炼 CRUD 容器组件,快速开始前端开发
- 基于 Ant Design 组件布局
- 提炼后台应用的典型页面和场景
- 提供 dataProvider 来适配各种数据规范
- 提供 dataProvider 来处理各种数据规范

## 架构

Expand Down
2 changes: 2 additions & 0 deletions docs/setup.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# 快速开始

create-react-app 脚手架快速创建项目

```bash
npm install prophet-core@latest prophet-antd@latest prophet-data-json-server@latest
```
Expand Down

0 comments on commit d9c849b

Please sign in to comment.