EziApp 文档

Appearance

创建你的第一个 EziApp 应用 ​

1、开发环境 ​

在开始之前，请确保你已经安装了以下工具：

  • Node.js  版本 22.12+
  • npm  通常随 Node.js 安装包一同提供

使用以下命令检查环境是否安装成功：

bash
node -v
npm -v

如果能正确输出版本号，说明环境已准备就绪。

WARNING

目前 EziApp 仅支持 Windows 平台，其他平台的支持仍在开发中。

2、创建项目 ​

通过以下命令快速生成一个 EziApp 项目：

bash
npm create eziapp@latest

执行后，npm 会下载并运行 create-eziapp 包，并引导你完成以下步骤：

a、 选择项目初始化方式 ​

☘  Select setup option:
  > Hello World Demo
    From EziApp Template
    From Existing Vite Project

直接按下回车即可选择默认的 Hello World Demo 模板。

b、输入项目名称 ​

☘  Project name:
  > eziapp-project

按下回车即可使用默认名称 eziapp-project，也可以输入自定义目录名称。
如果目录不为空，CLI 会提示是否清理已有文件，确保初始化安全。

c、完成项目创建 ​

✔  Hello World project setup is complete!

Next steps:

    cd eziapp-project
    npm install
    npm run dev

当你看到此提示，说明项目已成功创建。
接下来进入项目目录，安装依赖并启动开发环境。

3、项目结构 ​

生成的项目目录大致如下：

HelloWorld/
├── node_modules/*      # 项目依赖
├── public/image/       # 静态资源目录
│   └── ezi-logo.png
├── src/                # 源代码目录
│   ├── main.css
│   └── main.ts
├── index.html          # 应用入口 HTML
├── ezi.config.ts       # EziApp 配置文件
└── package.json        # 项目依赖与脚本配置

你可能已经注意到，在一个 EziApp 项目中，index.html 在项目最外层而不是在 public 文件夹内。这是 Vite 有意而为之的：转到 index.html 与项目根目录 查看更多信息。

4、调试运行应用 ​

使用以下命令启动调试模式：

bash
# 如果之前从未运行 npm install，需要先运行 npm install 安装依赖
npm run dev

运行后你会看到类似输出并自动启动一个应用程序：

$ npm run dev

> dev
> eziapp-builder --mode debug

! no vite.config.js found, using default config.
╔════════════════════════════════════════════════╗
║ VITE v7.2.2 ready in 54 ms                     ║
║                                                ║
║  ➜  devEntry: http://localhost:5173/          ║
║  ➜  EziApp:   helloworld running [pid:111104] ║
║  ➜  Package:  com.ezi.app.helloworld.debug    ║
║  ➜  Started:  2025/11/17 20:47:52             ║
╚════════════════════════════════════════════════╝
20:47:52 [helloworld] Hello from TypeScript!

此时你可以修改 src/main.ts 或 index.html，保存后应用程序页面会自动刷新。

TIP

修改 ezi.config.ts 后需要重新执行 npm run dev 才能生效。

5、构建与发布 ​

转到 构建与发布 查看更多信息。

常见问题 ​

  • 问：运行 npm run dev 或 npm run build 时提示： 'eziapp-builder' 不是内部或外部命令，也不是可运行的程序或批处理文件。
    答：请先执行 npm install 安装依赖，再重新运行。