uiw admin

UIW Admin Project

A starter level project based on uiw and @kkt/pro.

? Preview

characteristic

• ? The interactive language and visual style of enterprise-level mid- and back-end products.
• ? High-quality React backend management framework that works out of the box.
• ? Developed using TypeScript.
• Integrated login, Redux, tabs and other features.
• ? Complete routing, supporting both configured routing and agreed routing, while maintaining complete functions, such as dynamic routing, nested routing, permission routing, etc.

? Related dependencies

Package	Version	Description
@uiw-admin/basic-layouts		Components used for layout
@uiw-admin/document-title		Set page title
@uiw-admin/user-login		Login interface
@uiw-admin/components		Common business components
@uiw-admin/exceptions		Public exception component
eslint-config-uiw-admin		uiw-admin built-in eslint rule configuration

⌨️ Quick start

1. Directly download the example file uiw-admin-ts.zip uiw-admin-js.zip

2. Create project via command

 # npm 6.x
$ npm init uiw-admin my-app --example uiw-admin-ts
# npm 7+, extra double-dash is needed:
$ npm init uiw-admin my-app -- --example uiw-admin-ts

$ yarn create uiw-admin [appName]
# or npm
$ npm create uiw-admin my-app
# or npx
$ npx create-uiw-admin my-app

? Development start

Use yarn workspaces to manage node_modules

$ cd uiw-admin

$ yarn install

$ yarn build

$ yarn start

? Production build

$ cd uiw-admin

$ yarn build

? Directory structure

A basic uiw-admin project is roughly like this,

 .
├── README.md
├── config
│   ├── .kktprc.ts   # 配置文件可放在根目录下
│   └── routes.json  # 路由配置
├── mocker           # mock 数据
│   ├── auth
│   │   └── index.js
│   ├── demo.js
│   ├── index.js
│   ├── login.js
│   └── selectPage.js
├── package.json
├── public
│   ├── favicon.ico
│   └── index.html
├── src
│   ├── assets
│   │   ├── head.png
│   │   ├── logo-dark.svg
│   │   └── logo-light.svg
│   ├── index.css
│   ├── index.tsx
│   ├── layouts             # 框架组件
│   │   ├── BasicLayout.tsx # 框架菜单
│   │   ├── UserLayout.tsx  # 登陆页面
│   │   └── logo.svg
│   ├── models              # remach models
│   │   ├── Doc
│   │   │   └── doc.ts
│   │   ├── demo.ts
│   │   ├── global.ts
│   │   ├── home.ts
│   │   └── login.ts
│   ├── pages                 # 页面， 文件名大写
│   │   ├── Dashboard
│   │   │   └── index.tsx
│   │   ├── Demo
│   │   │   ├── Detail
│   │   │   │   ├── index.tsx
│   │   │   │   └── items.tsx
│   │   │   └── index.tsx
│   │   ├── TableList
│   │   │   └── index.tsx
│   │   └── login
│   │       ├── index.module.less
│   │       └── index.tsx
│   ├── react-app-env.d.ts
│   └── servers               # 放置api文件的地方，文件名已后端接口模块名命名，不以路由命名
│       └── index.ts
├── .kktprc.ts                # 配置文件可放在config目录下
└── tsconfig.json

❤️Contributor

Thanks to all contributors, developers are welcome to contribute to open source projects.

License

Licensed under the MIT License.