Skip to content

Latest commit

 

History

History
137 lines (103 loc) · 6.03 KB

README.zh-CN.md

File metadata and controls

137 lines (103 loc) · 6.03 KB

Vite-Boot

Vite-Boot - Opinionated Vite Starter Template

使用Vite-Boot快速地创建 Web 应用

特性

编码风格

推荐的 IDE 设置

性能

Vite-Boot Outstanding performance

项目结构

# vite-boot
├─.github                                # 存储 GitHub 相关配置文件。
│  ├─ISSUE_TEMPLATE                       # GitHub Issue 模板
│  └─workflows                            # GitHub Actions 相关配置文件
├─.husky                                  # 存储 Git Hooks 相关配置文件
│  └─_                                    # 存储 Git Hooks 执行脚本
├─.idea                                   # 存储 IntelliJ IDEA 相关配置文件
│  ├─codeStyles                           # 存储代码格式化规则
│  └─inspectionProfiles                  # 存储代码检测规则
├─.vscode                                 # 存储 VS Code 相关配置文件
├─public                                  # 存储 Web 应用所需的静态资源
├─README.assets                           # 存储 README.md 使用的图片等资源
├─src                                     # 存储 Web 应用源代码
│  ├─assets                               # 存储 Web 应用所需的静态资源
│  ├─components                           # 存储 Web 应用的组件
│  │  └─Icon                              # 存储表示图标的组件
│  ├─config                               # 存储 Web 应用的配置文件
│  │  ├─nprogress                         # 存储进度条库 NProgress 的配置文件
│  │  └─unocss                            # 存储 UnoCSS 的配置文件
│  ├─constant                             # 存储 Web 应用中使用到的常量值
│  ├─layouts                              # 存储 Web 应用的布局组件
│  │  ├─Footer                            # 存储表示页面底部的布局组件
│  │  └─Navbar                            # 存储表示页面导航栏的布局组件
│  │      └─components                    # 存储 Navbar 布局组件的子组件
│  │          ├─LocalesChange             # 存储表示语言切换的子组件
│  │          └─ThemeChange               # 存储表示主题切换的子组件
│  ├─locales                              # 存储 Web 应用的多语言内容文件
│  ├─router                               # 存储 Web 应用的路由配置文件
│  │  └─routes                            # 存储 Web 应用路由的模块
│  │      └─modules                       # 存储 Web 应用路由模块的子模块
│  ├─store                                # 存储 Web 应用的状态管理文件
│  ├─styles                               # 存储 Web 应用的样式文件
│  └─views                                # 存储 Web 应用的页面组件
│      ├─errorPages                       # 存储表示错误页面的组件
│      └─home                             # 存储表示主页的组件
│          └─components                   # 存储主页组件的子组件
├─test                                    # 存储测试代码
│  └─__snapshots__                        # 存储 Jest 快照测试的结果
└─types                                   # 存储 TypeScript 类型声明文件

快来试试吧!!

GitHub 模板

使用这个模板创建仓库.

克隆到本地

npx degit kirklin/vite-boot my-vite-app
cd my-vite-app
pnpm i

使用

开发

只需要执行以下命令就可以在 http://localhost:8888 中看到

pnpm run dev

构建

构建该应用只需要执行以下命令

pnpm run build

然后你会看到用于发布的 dist 文件夹被生成。

部署到 Netlify

前往 Netlify 并选择你的仓库, 一路 OK 下去,稍等一下后,你的应用将被创建.

Docker Production Build

首先,在项目的根目录下打开终端,构建vite-boot镜像。

docker buildx build . -t viteboot:latest

运行镜像,用 "-p" 指定端口映射。

docker run --rm -it -p 8080:80 viteboot:latest