/react-ts-app-starter

一个用于快速创建 React 项目的模板脚手架，使用 TypeScript、Webpack 与 Storybook 构建. A boilerplate for creating a React application, using TypeScript, Webpack and Storybook.

Primary LanguageJavaScriptMIT LicenseMIT

react-ts-app-starter

English Documentation

一个用于快速创建 React 项目的模板脚手架，使用 TypeScript、Webpack 与 Storybook 构建.

快速开始

git clone https://github.com/senntyou/react-ts-app-starter.git --depth=1

cd react-ts-app-starter

npm install             # 安装依赖

npm run storybook       # 使用 storybook 开发组件

特性

主要命令

dev: 开启一个本地服务器开发一个 entry

lila dev                     # 单页面应用 (全局命令)
npx lila dev                 # 单页面应用 (本地命令)
lila dev [entry]             # 多页面模式 (全局命令)
npx lila dev [entry]         # 多页面模式 (本地命令)

serve: 模拟一个后端环境，开启一个本地服务器开发一个 entry

lila serve                   # 单页面应用 (全局命令)
npx lila serve               # 单页面应用 (本地命令)
lila serve [entry]           # 多页面模式 (全局命令)
npx lila serve [entry]       # 多页面模式 (本地命令)

build: 打包源代码

lila build                                  # 单页面应用 (全局命令)
npx lila build                              # 单页面应用 (本地命令)
lila build [entry1] [entry2] ...            # 多页面模式 (全局命令)
npx lila build [entry1] [entry2] ...        # 多页面模式 (本地命令)

sync: 打包源代码, 并同步到服务器

lila sync                                   # 单页面应用 (全局命令)
npx lila sync                               # 单页面应用 (本地命令)
lila sync [entry1] [entry2] ...             # 多页面模式 (全局命令)
npx lila sync [entry1] [entry2] ...         # 多页面模式 (本地命令)

start: 打包源代码, 并开启一个本地服务器预览

lila start                   # 单页面应用 (全局命令)
npx lila start               # 单页面应用 (本地命令)
lila start [entry]           # 多页面模式 (全局命令)
npx lila start [entry]       # 多页面模式 (本地命令)

analyze: 查看当前 entry 的各个模块文件的大小

lila analyze                 # 单页面应用 (全局命令)
npx lila analyze             # 单页面应用 (本地命令)
lila analyze [entry]         # 多页面模式 (全局命令)
npx lila analyze [entry]     # 多页面模式 (本地命令)

项目

- src                        # 源文件目录
- .storybook                 # for storybook
- stories                    # for storybook

单页面应用目录结构

- src
  - index.html               # html 入口文件
  - index.ts                 # ts 入口文件

  - 其他文件与目录

多页面模式目录结构

- src
  - page1                    # entry: page1
    - index.html             # html 入口文件
    - index.ts               # ts 入口文件

    - 其他文件与目录

  - module1
    - page2                  # entry: module1/page2
      - index.html           # html 入口文件
      - index.ts             # ts 入口文件

每个 entry 都有一个单独的目录(目录为 src/home/about/ 如果 entry 是 home/about), 也叫做工作空间, 在这个工作空间中至少有一个 index.html 文件和一个 index.ts 文件.

自定义 webpack 配置

如果需要更改默认的 webpack 配置, 可以到 scripts/lila-webpack-config 修改.

外部引用

项目使用 lila 开发与构建. 如果想知道更多关于:

  • 怎样配置 lila.init.js
  • 怎样运行 lila
  • lila 有哪些特性

可以到 lila 查看更多.