Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 3.55 KB

README.zh-CN.md

File metadata and controls

76 lines (52 loc) · 3.55 KB

Admin Template for React

演示 - 输入任意字符,即可登录

code style: prettier

这是一个基于 React 技术栈的项目,使用了 React Redux, Material UI 等组件。项目使用 TypeScript 为主要编程语言,同时使用了 Webpack 来打包。

  • AJAX 组件: axios
  • UI 组件: material-ui
  • React 组件: react, react-dom, react-redux, react-router-config, react-router-dom, redux, redux-saga
  • 你可以在**./src/theme/config.tsx**文件中,定义自己的主题样式

本地启动项目

  1. 通过命令下载源代码 git clone <git-url>
  2. 运行npm install命令安装所有的依赖项
  3. 运行npm start命令启动项目,或者运行npm run build命令来编译代码,最终产线的代码将会被编译至dist目录中。

开发

项目配置文件

  • ./src/config/app.common.tsx - 公共配置项,以下所有配置文件,将继承与它
  • ./src/config/app.dev.tsx - 本地开发项目配置文件
  • ./src/config/app.prod.tsx - 产线环境配置文件
  • ./src/config/app.github.tsx - 与 GitHub 集成的配置文件
  • ./src/config/app.auth-code.tsx - 基于 OAuth Authorizaotn Code 的配置文件示例
  • ./src/config/app.auth-password.tsx - 基于 OAuth Password Grant Type 的配置文件示例
  • ./src/config/app.mock.tsx - 没有任何登录系统时,使用的配置文件。

自定义更多的配置文件

  1. 创建名为 ./src/config/app.[env_name].tsx 的配置文件

  2. app.dev.tsx文件中,导入你新创建的配置文件。

    import config = require('./app.your-env');

    或者,你可以在 ./src/config/index.tsx or ./index.html 文件中,指定你需要使用的配置文件(此项会忽略其它设置,将会一直使用你指定的配置文件,无论本地环境,还是npm run build生成的线上环境),例如:

    window.__APP_ENV__ = 'your-env';
  3. 运行npm start命令启动本地项目,此时,就会使用你新创建的配置文件项。

可用的 UI 组件如下,更多请见**/src/ui**文件夹

Alert, Loading, MiniCard, Notifier, Overlay, Panel, Tag, DataTable, ...

多语言支持

import * as intl from 'react-intl-universal';

const message = intl.get('i18nKey');

可用的服务

  • import { service as resourceService } from "app/service/resource"; - 使用 resourceService 来调用所有的 API, 此方法将会将 Access Token 附加到请求的 Header 中
  • import { getState as getAuthState } from "app/service/auth"; - getAuthState() 获取当前登录用户信息