nicecode-v2/docs/index.md

3.6 KiB
Raw Blame History

hero features
title description actions
lambo 致力于提升前端开发效率与规范
text link
快速上手 /bizs
title emoji description
biz 🍑 业务库
title emoji description
hooks 💎 hooks
title emoji description
func 🌈 常用函数库
title emoji description
meta ☀️ 原子组件库
title emoji description
constants 🈶 静态定义库
title emoji description
request 🥣 网络请求库
title emoji description
types 🈸 typescript 声明库
title emoji description
material 🥱 物料库
title emoji description
cli 🐔 脚手架

目录结构

  • docs 全局文档
    • index.md 这是首页文档
  • packages 组件包目录
    • biz 业务组件
    • func 函数库
    • hooks hooks
    • constants 静态枚举值定义
    • meta 元组件
    • request 请求库
    • types 类型定义库
    • material 物料库
    • cli 脚手架
  • src 这是 src 文件夹
    • index.md 这是 index.md
  • .dumirc.ts 文档配置
  • package.json 这是 package.json

本文档食用说明

目前在进行中的项目为:@zhst/bizs、@zhst/hooks、@zhst/meta、@zhst/func..

bizs: 基于@zhst/hooks、@zhst/meta、@zhst/func 开发基本贴近于业务。doing

meta基于 antd 开发作为公司的定制化原子组件。doing

hooks基于 ahooks、@zhst/func 定制化二次开发。doing

func基于 lodash-es 定制化二次开发 (由于 utils 包名被使用了)doing

后续构思

想做一个,基于智慧视通开发场景和业务场景的前端技术流程化方案,希望它能渗透到整个研发的所有流程中。

比如代码规范、git 提交规范、物料库、基于 electron 的前端工具客户端可集成物料库、图片上传小工具、api 自动生成...

:::info{title=@zhst/lint} lint 工具库包含eslint-config、eslint-plugin、commit-lint :::

:::info{title=@zhst/metarial} 物料库,可以直接通过 clone npm 仓库的形式生成模板页面,页面没有任何依赖,一个页面就是一个项目。 :::

:::info{title=@zhst/app} 基于 electron 的前端客户端工具初期功能构思方案有文件上传、git 仓库管理、物料库可视化页面一键生成 :::

:::info{title=@zhst/autoapi} 接口一键生成工具 :::

:::info{title=@types/zhst} 类型定义库 :::

:::info{title=@zhst/constants} 静态变量枚举库 :::

:::info{title=@zhst/cli} 基于物料库的脚手架,可以直接通过可视化界面搭建项目,偏向于 lowcode+ 思维 :::