mirror of
https://github.com/HackPlan/uui-admin-template.git
synced 2026-01-12 22:27:11 +08:00
49 lines
2.5 KiB
Markdown
49 lines
2.5 KiB
Markdown
# UUI Admin Template
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
English | [简体中文](https://github.com/HackPlan/uui-admin-template/blob/master/docs/README.zh-CN.md)
|
|
|
|
## Introduction
|
|
|
|
`uui-admin-template` is a React boilerplate for admin applications, it is based on React and uses the UI library [UUI](https://github.com/HackPlan/UUI). The purpose of developing and open source this template project: On the one hand, you can look through the code of this template project to understand how to use UUI correctly; on the other hand, you can manually fork a copy of this project or directly use the `Use this Template` button to quickly create a startup project.
|
|
|
|
> This is a admin template boilerplate project and will not be released to NPM as a general library, so when you decide to use it and commit it to your business project as a code base, in theory, subsequent updates of uui-admin-template will require you manually migrate to your own project. This project is not a fool-proof one. It requires a certain front-end development knowledge and ability. We strongly recommend that you are familiar with every line of code in this project and read all the documents.
|
|
|
|
## Features
|
|
|
|
* [Project Intro](https://github.com/HackPlan/uui-admin-template/blob/master/docs/PROJECT.zh-CN.md)
|
|
* [Auth](https://github.com/HackPlan/uui-admin-template/blob/master/docs/AUTH.zh-CN.md)
|
|
* [Route](https://github.com/HackPlan/uui-admin-template/blob/master/docs/ROUTE.zh-CN.md)
|
|
* [Navigation](https://github.com/HackPlan/uui-admin-template/blob/master/docs/NAVIGATION.zh-CN.md)
|
|
* [Layout](https://github.com/HackPlan/uui-admin-template/blob/master/docs/LAYOUT.zh-CN.md)
|
|
* [API & Mock](https://github.com/HackPlan/uui-admin-template/blob/master/docs/API_AND_MOCK.zh-CN.md)
|
|
* [Icon](https://github.com/HackPlan/uui-admin-template/blob/master/docs/ICON.zh-CN.md)
|
|
|
|
|
|
## Getting started
|
|
|
|
```bash
|
|
git clone https://github.com/HackPlan/uui-admin-template.git
|
|
cd uui-admin-template
|
|
yarn
|
|
yarn start
|
|
|
|
```
|
|
|
|
This will automatically open http://localhost:3000
|
|
|
|
## Build
|
|
|
|
```bash
|
|
yarn build
|
|
```
|
|
|
|
## Licenses
|
|
|
|
All files on the UUI GitHub repository are subject to the MIT license. Please read the License file at the root of the project.
|