/sealion-client

SeaLion Client can help create project quickly

Primary LanguageTypeScript

logo

SeaLion Client是一款构建前端项目和代码的工具包


Static Badge Static Badge Static Badge Static Badge

English· 简体中文

快速使用

创建项目

slc create my-app
cd my-app
npm run dev

logo

打开 http://localhost:5173 查看。
当你准备部署到生产环境时,执行npm run build生成压缩的bundle。

创建React组件

slc g -c my-component

logo


执行后会在当前目录下创建my-component组件

特性

  • 模板技术栈:react + typescript + less;
  • 可以选择vite或者webpack做为打包工具;
  • 可以快速创建基础组件物料。

安装

# mac和ubuntu需要加sudo
npm install -g sea-lion-client

功能


创建app

slc create my-app

项目目录如下(以默认模板为例,列出常用文件)

my-app
├── env
├── mock
├── node_modules
├── public
├── script
├── vite.config.ts
├── index.html
└── src
    ├── assets          # 静态资源
    ├── components      # 项目通用组件
    ├── config          # 类似权限功能的配置文件
    ├── interceptors    # response & request 中间件,基于axios开发
    ├── layouts         # 布局组件
    ├── locales         # 国际化文字物料
    ├── routes          # 路由
    ├── services        # 接口请求函数
    └── styles          # 项目通用样式
    └── utils           # 工具函数
    └── app.tsx
    └── main.tsx       
    └── vite-env.d.ts

传入模板创建app
# 使用模板@sea-lion/app-template创建my-app
slc create my-app -t @sea-lion/app-vite-template

模板可选项

模板 功能 备注
@sea-lion/app-vite-template 使用vite构建的项目开发环境 默认模板,推荐使用
@sea-lion/lib-template 使用rollup构建的库开发环境
@sea-lion/app-template 使用webpack5构建的项目开发环境 不再维护

创建组件

cd ./src/components
slc g -c my-component

生成物如下图所示,当使用slc创建物料和项目时,slc首先会在当前目录下进行重名文件效验,避免覆盖。




查看版本

slc -v

开发

安装依赖

lerna bootstrap

本地运行

node packages/sea-lion-client/bin/sea-lion-client.js create [app-name]