Skip to content

基于 pnpm 搭建的 monorepo 架构的知识库。架构与文档于一体的知识库,沉淀各种解决方案并直达源码的直观文档。

Notifications You must be signed in to change notification settings

Ting-Code/Ting-Library-Monorepo

Repository files navigation

pnpm Vite Vite

pnpm React MicroApp Nextjs

Ting Library:基于 pnpm 搭建的 monorepo 架构的知识库。架构与文档于一体的知识库,沉淀各种解决方案并直达源码的直观文档。

Ting Library 目前实现基于 MicroApp 搭建微前端, rspack搭建React、Vite搭建Vue3 等子应用,独立的共享库、工具库、vue组件库,集成前端各种解决方案以及可直达源码的文档设计。并实现了Github Action 自动化打包与部署Docker镜像。

快速开始

# 执行tingcli (必须是最新版pnpm)
pnpm create tingcli

# 选择monorepo
  cli
❯ monorepo

# 输入项目名
? 项目类型 monorepo
? 项目名称 project-name

# 初始化项目 (必须是最新版pnpm)
pnpm install

启动项目

# 启动项目 (单选)
pnpm dev

? 请选择需要执行的项目 » - 上下选择,空格切换,回车确定
>   @apps/admin
    @apps/micro
    ...

# 构建 (多选)
pnpm build

? 请选择需要执行的项目 » - 上下选择,空格切换,回车确定
Instructions:
    ↑/↓: Highlight option
    ←/→/[space]: Toggle selection
    a: Toggle all
    enter/return: Complete answer
( )   @apps/admin
( )   @apps/micro
( )   @tingcli/create
( )   @tingcli/cli-utils
( )   @tingcode/lib-vue
( )   vite-plugin-code
      ...

目录结构


Ting-Library-Monorepo
├─.changeset
├─.github  # github action
|    ├─workflows
|    |     ├─docker-deploy.yml # github action 自动化脚本
|    |     ├─dockerBootstrap.sh # 服务端脚本
|    |     ├─Dockerfile # 通过Dockerfile构建image
|    |     └nginx.conf # nginx配置
├─.husky # git钩子 主要是commit lint
├─configs
|    ├─tsconfig
|    ├─lint # 各种lint相关配置
├─packages
|    ├─apps
|    |  ├─admin # Vite搭建vue3主应用
|    |  ├─micro-docs # Vite 搭建Docs文档子应用
|    |  ├─micro-react # Rspack 搭建React子应用
|    ├─cli # 自定义脚手架cli
|    |  ├─utils
|    |  ├─template # cli模板
|    |  ├─create # 创建模板cli
|    ├─lib
|    |  ├─request # 请求相关封装
|    |  ├─system # 微前端共享库
|    |  ├─utils # 工具函数库
|    |  ├─vue # vue组件库
|    ├─plugin # 相关自定义插件
|    |   ├─vite-plugin-code # docs文档生成插件
├─scripts # 构建脚本

版本进度

  • 架构 - 基于 pnpm 构建 monorepo v0.1.0 ✅

  • 架构 - Github Actions 自动化部署 v0.1.0 ✅

  • 架构 - MicroApp 构建微前端 v0.2.0 ✅

  • 架构 - Rspack 搭建 React 子应用 v0.1.0 ✅

  • 架构 - Vite 搭建 Vue3 主应用 v0.1.0 ✅

  • 架构 - vue独立组件库 v0.3.0 ✅

  • 架构 - 抽离Docs为独立子应用 v0.3.0 ✅

  • 架构 - 与业务耦合的System共享包 v0.3.0 ✅

    • 系统 - 知识库主体 v0.1.0 ✅
    • 系统 - 主题切换 v0.1.0 ✅
    • 系统 - 实现主页布局 v0.1.0 ✅
    • 系统 - 适配移动端 v0.1.0 ✅
    • 插件 - 自定义 vite 插件注入展示源码 v0.2.0 ✅
  • 页面 - 首页 v0.1.0 ✅

  • 导航 - 架构设计 v0.1.0 ✅

    • 页面 - 介绍页 v0.2.0 ✅
    • 页面 - 文档设计 v0.2.0 ✅
    • 页面 - 微前端 v0.2.0 ✅
    • 页面 - 404 页面 v0.1.0 ✅
  • 导航 二次封装 v0.2.0 ✅

    • 二次封装技巧 v0.2.0 ✅

贡献人员

游客打卡点

About

基于 pnpm 搭建的 monorepo 架构的知识库。架构与文档于一体的知识库,沉淀各种解决方案并直达源码的直观文档。

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •