antdp/README.md

Ant Design Project

Ant Design Project
---

[![Build & Deploy](https://github.com/antdpro/antdp/actions/workflows/ci.yml/badge.svg)](https://github.com/antdpro/antdp/actions/workflows/ci.yml)
[![NPM Downloads](https://img.shields.io/npm/dm/antdp.svg?style=flat)](https://www.npmjs.com/package/antdp)

一个基于 [antd](https://github.com/ant-design/ant-design/) 和 [umi](https://github.com/umijs/umi) 的初始级别项目，集成路由、[`dva`](https://github.com/dvajs/dva)(Redux)、选项卡等特性，用于简化 [antd 5.x +](https://github.com/ant-design/ant-design) 的部分使用。

[![Ant Design Project](https://user-images.githubusercontent.com/59959718/262203847-d1612c3c-a37e-47fa-8282-dba85a8366be.png)](https://stackblitz.com/github/antdpro/antdp/tree/master/examples/antdp-base?embed=1&hideNavigation=0&hidedevtools=0)


### Features

- 🪖 简化 [antd 5.x +](https://github.com/ant-design/ant-design) 和 [umi](https://github.com/umijs/umi) 框架配置使用；
- 📦 减少项目配置和依赖，将配置集成到包中开箱即用；
- 🐝 更简单直观的配置权限和更改 Layout；
- 💋 支持配置路由参数 `/router/:id`；
- 🤡 支持 `tab` 选项卡功能。

### 创建ts项目

使用 [`create-antdp`](https://antdpro.github.io/create-antdp) 工具，将示例 [`basic`](https://antdpro.github.io/antdp/zip/basic.zip) 初始化，让我们快速创建这个 React 应用程序：

```shell
# npm 6.x ts版本
$ npm init antdp my-app --example basic
# npm 7+,ts版本 extra double-dash is needed:
$ npm init antdp my-app -- --example basic

$ yarn create antdp [appName]
# or npm
$ npm create antdp my-app
# or npx
$ npx create-antdp my-app
```

或者直接下载版本: [`basic.zip`](https://antdpro.github.io/antdp/zip/basic.zip)

### 创建js项目
```shell
# npm 6.x
$ npm init antdp my-app --example basicjs
# npm 7+，extra double-dash is needed:
$ npm init antdp my-app -- --example basicjs

$ yarn create antdp [appName] -- --example basicjs
# or npm
$ npm create antdp my-app -- --example basicjs
# or npx
$ npx create-antdp my-app -- --example basicjs
```
或者直接下载版本: [`basicjs.zip`](https://antdpro.github.io/antdp/zip/basicjs.zip)
### 在CodeSandbox中打开，查看实例

[![Open in CodeSandbox](https://img.shields.io/badge/Open%20in-CodeSandbox-blue?logo=codesandbox)](https://codesandbox.io/s/github/antdpro/antdp/tree/master/examples/antdp-base)
[![Open in StackBlitz](https://img.shields.io/badge/Open%20in-StackBlitz-blue?logo=)](https://stackblitz.com/github/antdpro/antdp/tree/master/examples/antdp-base?embed=1&hideNavigation=0&hidedevtools=0)
[![Open in Codeanywhere](https://img.shields.io/badge/Open%20in-Codeanywhere-blue?style=flat-square&logo=codeanywhere)](https://app.codeanywhere.com/#https://github.com/antdpro/antdp/tree/master/examples/antdp-base)

用户名密码： admin/admin

你可以也直接下载实例下载本地预览: [`antdp-base.zip`](https://antdpro.github.io/antdp/zip/antdp-base.zip)

### 启动项目
```bash
cd [appName]
yarn install
yarn start
```

### 目录结构
```bash
├── config
│   ├── config.js
│   ├── proxy.js
│   └── router.json
├── mock
│   ├── load.js
│   └── user.js
├── package.json
└── src
    ├── components
    ├── layouts
    ├── locales
    ├── models
    ├── pages
    ├── services
    └── utils
```
### 相关依赖

This git repository is a repo built using Lerna. It contains several packages:

Package | Version | Description
---- | ---- | ----
[`@antdp/authorized`](https://www.npmjs.com/package/@antdp/authorized) | [![npm](https://img.shields.io/npm/v/@antdp/authorized.svg?maxAge=3600)](https://www.npmjs.com/package/@antdp/authorized) | - |
[`@antdp/basic-layouts`](https://www.npmjs.com/package/@antdp/basic-layouts) | [![npm](https://img.shields.io/npm/v/@antdp/basic-layouts.svg?maxAge=3600)](https://www.npmjs.com/package/@antdp/basic-layouts) | - |
[`@antdp/antdp-ui`](https://www.npmjs.com/package/@antdp/antdp-ui) | [![npm](https://img.shields.io/npm/v/@antdp/antdp-ui.svg?maxAge=3600)](https://www.npmjs.com/package/@antdp/antdp-ui) | - |
[`@antdp/document-title`](https://www.npmjs.com/package/@antdp/document-title) | [![npm](https://img.shields.io/npm/v/@antdp/document-title.svg?maxAge=3600)](https://www.npmjs.com/package/@antdp/document-title) | - |
[`@antdp/fullscreen`](https://www.npmjs.com/package/@antdp/fullscreen) | [![npm](https://img.shields.io/npm/v/@antdp/fullscreen.svg?maxAge=3600)](https://www.npmjs.com/package/@antdp/fullscreen) | - |
[`@antdp/user-login`](https://www.npmjs.com/package/@antdp/user-login) | [![npm](https://img.shields.io/npm/v/@antdp/user-login.svg?maxAge=3600)](https://www.npmjs.com/package/@antdp/user-login) | - |
[`@antdp/layout-tabs`](https://www.npmjs.com/package/@antdp/layout-tabs) | [![npm](https://img.shields.io/npm/v/@antdp/layout-tabs.svg?maxAge=3600)](https://www.npmjs.com/package/@antdp/layout-tabs) | - |
[`@antdp/config`](https://www.npmjs.com/package/@antdp/config) | [![npm](https://img.shields.io/npm/v/@antdp/config.svg?maxAge=3600)](https://www.npmjs.com/package/@antdp/config) | - |
[`@antdp/dependencies`](https://www.npmjs.com/package/@antdp/dependencies) | [![npm](https://img.shields.io/npm/v/@antdp/dependencies.svg?maxAge=3600)](https://www.npmjs.com/package/@antdp/dependencies) | - |
[~~`@antdp/icons`~~](https://www.npmjs.com/package/@antdp/icons) | [![npm](https://img.shields.io/npm/v/@antdp/icons.svg?maxAge=3600)](https://www.npmjs.com/package/@antdp/icons) | - |
[`@antdp/page-loading`](https://www.npmjs.com/package/@antdp/page-loading) | [![npm](https://img.shields.io/npm/v/@antdp/page-loading.svg?maxAge=3600)](https://www.npmjs.com/package/@antdp/page-loading) | - |

### 参与框架开发
```bash
git clone https://github.com/antdpro/antdp.git
```

```bash
npm install               # 安装项目依赖
npm run build             # 实时监听包输出 JS
npm run start:website     # 运行文档网站
npm run start:antdp-base  # 运行实例
```

### 发布版本

```shell
npm run version -- patch # 配置的命令快捷方式，与下面命令效果相同
lerna version --no-changelog patch
```

发布版本可选参数，通过该关键字增加版本。

```bash
lerna version [major | minor | patch | premajor | preminor | prepatch | prerelease]
```

- `major` - 重大的 `1.1.1 => 2.0.0`
- `minor` - 小调 `1.1.1 => 1.2.0` 中间版本变化
- `patch` - 补丁 `1.1.1 => 1.1.2` 小版本递增
- `premajor` - 预发布重大的 `1.1.1 => 2.0.0-alpha.0`
- `preminor` - 预发布小调 `1.1.1 => 1.2.0-alpha.0`
- `prepatch` - 预发布补丁 `1.1.1 => 1.1.2-alpha.0`
- `prerelease` - 预发行 `1.1.1 => 1.1.2-alpha.0`


### License

Licensed under the MIT License.