tntweb admin下載 - tntweb admin原始碼下載

tntweb admin

其他類別

1.0.0

下載

概述

tntweb-admin是一個幫用戶整合concent和react相關生態庫並內建了最佳實踐指導的項目，以便提供給用戶開箱即用的體驗，包括但不局限於以下功能：

常用concent api示範
model目錄組織示範
ts整合示範
測試案例書寫示範

本專案使用webpack開發與構建，同時也提供了基於vite的vite-concent-pro版本，兩者src源碼一樣，推薦給喜歡嘗試vite的朋友

預覽

線上範例

安裝與運行

拉取項目代碼

git clone https://github.com/tnfe/concent-pro.git
cd concent-pro

安裝相關依賴

npm i --registry=https://registry.npmjs.org

啟動與調試項目

npm start （包含启动前端 和 mock服务）
// 如需分开启动
npm run api （启动mock服务）
npm run app （启动前端）

測驗與格式校驗

npm run test (jest测试)
npm run lint (eslint校验)
npm run lintfix (eslint修复)

程式碼提交與推送

 git commit -am 'xxxx_msg' (触发 husky钩子 pre-commit: npm run lintfix)
git push (触发 husky钩子 pre-commit: npm run test)

新增頁面

新增選單與路由
src/configs/menus裡加入路由對應的選單信息
新增路由頁面
src/pages目錄下新增頁面元件

可參考src/pages/_DemoTempalte查看範例程式碼，啟動專案後造訪localhost:3000/template可以存取該元件頁面

新增模組

模組可在src/models目錄下添加，也可以在pages/XxxComp裡就近添加業務模組，需注意都要在src/models/index.ts檔案裡暴露出去，模組名統一維護在src/configs/c2Mods.ts文件

新增模組名

 // src/configs/c2Mods.ts文件
export const HELLO = modName('Hello');
export type T_HELLO = typeof HELLO;

新增多檔案模組在src/models下方加入目錄hello ，將模組的state , reducer , computed拆開寫

 | ____models              
| |____hello             
| | |____state.ts
| | |____reducer.ts
| | |____computed.ts
| | |____index.ts

定義狀態【必需】

 function getInitialState ( ) {
  return {
    str : '' ,
    loading : false ,
  } ;
}
export type St = ReturnType < typeof getInitialState > ;
export default getInitialState ;

定義方法【可選】

 import { St } from './state' ;
import { VoidPayload , AC } from 'types/store' ;
import { T_HELLO } from 'configs/c2Mods' ;
import { delay } from 'utils/timer' ;

type IAC = AC < T_HELLO > ;

export function simpleChange ( payload : string , moduleState : St , ac : IAC ) {
    return { str : payload } ;
}

export async function complexChange ( payload : string , moduleState : St , ac : IAC ) {
    await ac . setState ( { loading : true } ) ;
    await delay ( 2000 ) ;
    // 下面两句可合写为：return {str:payload, loading: false};
    ac . dispatch ( simpleChange , payload ) ; // 当前文件内复用其他reducer逻辑
    return { loading : false } ;
}

定義計算【可選】

 import { St } from './state' ;

// only value change will triiger this function to execute again
export function reversedStr ( { str } : St ) {
  return str . split ( '' ) . reverse ( ) . join ( '' ) ;
}

src/models/hello/index.ts檔案暴露模組

 import { HELLO } from 'configs/c2Mods' ;
import state from './state' ;
import * as computed from './computed' ;
import * as reducer from './reducer' ;

export default {
  [ HELLO ] : {
    state ,
    computed ,
    reducer ,
  }
} ;

src/models/index.ts檔案引入模組合併到根模組

 import global from './global'; // 覆写concent内置的$$global模块
import Hello from './hello';

const toExport = {
  ...Hello,
  ...global,
};

export default toExport;

任務組件使用useC2Mod消費模組數據，使用模組方法

 import { useC2Mod } from 'services/concent' ;
import { HELLO } from 'configs/c2Mods' ;

export function SomeComp ( ) {
    // state:数据，mr:方法
    const { state , mr } = useC2Mod ( HELLO ) ;
}

編碼建議

1 pages里拆分的元件如不涉及到跨頁面復用，推薦就近放置，如後期復用在移到components/**下
2 page模組狀態推薦就近放置

技術堆疊

運行時依賴

react 16.13.1 元件化程式設計ui基礎函式庫
react-router v5 react路由方案
concent v2 內建依賴收集，高效能、漸進式的react開發框架
react-router-concent v2 橋接react-router和concent的中間函式庫
ant-design v4 react基礎ui元件庫

開發依賴

create-react-app v3
mocker-api v1.13
eslint
webpack
typescript
jest
husky

根目錄結構

 |____config             # CRA webpack相关配置[由npm run eject弹出]   
|____mock               # mock api配置
|____public             # webpack-dev-server 静态资源目录
|____scripts            # npm 脚本
|____src                # 项目源码

src目錄結構

 |____configs
| |____constant           # 各种常量定义处目录
| |____runConcent.ts      # 启动concent
| |____menus.ts           # 站点菜单配置(包含了路由)
| 
|____index.tsx            # app入口文件
|____utils                # 通用的非业务相关工具函数集合（可以进一步按用途分类）
|____models               # [[business models(全局模块配置)]]
| |____index.js           # 如需全局各个组件共享的model，可提升到此处导出（model可就近放置也可放到models目录下）
| |____global             # [[ 一个标准的模块文件(可以copy到各处，只需修改meta里的模块名即可 ]]
| | |____index.ts         # 模型导出文件
| | |____reducer.ts       # 修改模块数据方法(可选)
| | |____computed.ts      # 模块数据的计算函数(可选)
| | |____watch.ts         # 模块数据的观察函数(可选)
| | |____lifecycle.ts     # 模块生命周期配置(可选)
| | |____state.ts         # 模块状态(必需)
| | |____meta.ts          # 模块元数据文件- 导出整个模块的描述对象、相关类型、钩子等
| |____...
| |
|____components           # [[多个页面复用的基础组件集合]]
|
|____pages                # [[页面组件，通常也是路由组件]]
| |____PageFoo
|   |____ model           # 当前页面的model定义，方便就近打开就近查看（定义可见models/global）
|   |____ dumb            # 当前页面的一些业务笨组件（如果出现多个页面重用则可以进一步调整到components/dumb下）
|
|____types                # 类型定义目录
| |____store              # store相关的各种类型推导文件(这是一个固定的文件，无需用户改动)
| |____mods               # 模型推导辅助文件，无需用户修改
| |____ev-map             # 事件相关的类型定义
| |____domain             # 业务领域相关的对象类型定义，通常是后端返回的对象
| |____biz                # 其他一些全局通用的前端定义的对象类型
|
|
|____services             # [[services，涉及业务io相关、业务通用逻辑相关下沉到此处]]
| |____domain             # 领域模型相关服务
| | |____user
| | |____ticket
| |____common-func        # 和领域无关的基础业务函数集合
| |____http               # 其他业务基础服务
| |____...