Skip to content

This is a more radical visualization build solution toy for projects with vue3.2+/TS/vite technology stacks

License

Notifications You must be signed in to change notification settings

xxf1996/carverry

Repository files navigation

img

carverry

这是一个比较激进的可视化搭建方案玩具,适用于vue3.2+/TS/vite技术栈的项目;目的在于利用可视化快速搭建页面,注入逻辑变量,然后自动生成拼接好的胶水代码;目前主要由三个包组成:

  • @carverry/appimg
  • @carverry/coreimg
  • @carverry/helperimg

快速开始

  1. 首先全局安装 ts-node@carverry/app@carverry/core
npm i -g ts-node @carverry/app @carverry/core #or
yarn global add ts-node @carverry/app @carverry/core #or
pnpm add -g ts-node @carverry/app @carverry/core

​ 如果安装完了这些包,想要快点进行玩耍的话,可以直接clone示例项目进行使用;

  1. 然后在项目命令行进行初始化:
carverry init

按照交互式命令进行对应选项的配置:

image

如果想全部使用默认配置,可以使用-y选项来完成:

carverry init -y
  1. 接着在项目中使用@carverry/helper来注册可视化预览相关的路由:
yarn add -D @carverry/helper

安装完@carverry/helper后,需要在项目启动配置文件里对router实例使用一个辅助函数

import { addCarverryRoute } from '@carverry/helper';
// ...

if (import.meta.env.MODE === 'development') { // 仅需要在开发环境引入
  addCarverryRoute(router, () => {
    // ... 这里是注册完可视化预览路由成功后的钩子,可以在这里做一些自定义逻辑,主要是涉及到路由数据相关的
  });
}
  1. 完成配置后,先启动本地项目开发环境,然后再启动可视化搭建应用了:
yarn dev # 启动本地项目开发环境,具体命令取决于各自的配置
carverry start #or
carverry #可以直接省掉start命令,因为默认命令就是start

相关文档

  • 操作文档:关于可视化搭建应用的各种操作和基本概念
  • 物料开发文档:TODO
  • 开发文档:TODO

物料包

注意事项

  • node版本需要16+

About

This is a more radical visualization build solution toy for projects with vue3.2+/TS/vite technology stacks

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published