懂AI
nextron

nextron

Next.js与Electron融合的桌面应用开发框架

Nextron是一个整合Next.js和Electron技术的开发框架，让开发者能够使用Web技术轻松构建桌面应用。该框架支持JavaScript和TypeScript，提供多个实用示例和灵活配置选项。Nextron简化开发流程，支持热重载，并具备便捷的生产构建功能。从基础应用到集成高级UI库，Nextron能够满足多样化的桌面应用开发需求。

NextronElectronNext.js桌面应用开发跨平台开发Github开源项目
访问官网GitHub论文文档
<p align="center"><img src="https://i.imgur.com/0vkxIMN.png"></p> <p align="center"> <a aria-label="NPM 版本" href="https://www.npmjs.com/package/nextron"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/e477234e-4025-4a48-b28d-cb390b97a04b.svg?style=for-the-badge&labelColor=000000" alt="NPM 版本"> </a> <a aria-label="NPM 下载量" href="https://www.npmjs.com/package/nextron"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/b1d419d5-c58e-4262-97a4-8e8dce3e637d.svg?style=for-the-badge&labelColor=000000" alt="NPM 下载量"> </a> <img src="https://yellow-cdn.veclightyear.com/835a84d5/e4c2c593-39a1-4d19-ada8-d289525db887.svg?style=for-the-badge&labelColor=000000" alt="包许可证 (MIT)"> <a aria-label="AWESOME NEXTJS" href="https://github.com/unicodeveloper/awesome-nextjs"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/e7478dd5-5f7f-449b-bc27-a178a7012edd.svg?style=for-the-badge" alt="AWESOME NEXTJS"> </a> </p> <h2 align="center"> <a aria-label="2024年路线图 - 我回来了！" href="https://github.com/saltyshiomix/nextron/issues/442"> 2024年路线图 - 我回来了！ </a> </h2>

支持

Next.js 与 Nextron 版本对应关系

nextnextron
v14.xv9.x
v12.x / v13.xv8.x
v11.xv7.x
v10.xv6.x
v9.xv5.x
v8.xv4.x
v7.xv2.x / v3.x
v6.xv1.x

包管理器

支持 npm、yarn 和 pnpm。

我对 Nextron 的理念

  1. 展示仅使用 Web 知识开发桌面应用的方法
  2. 易于使用
  3. 对开源开发者保持透明和开放

使用方法

使用模板创建应用

我们可以使用 examples/* 作为模板。

要创建 examples/with-tailwindcss，请运行以下命令：

# 使用 npx
$ npx create-nextron-app MY_APP --example with-tailwindcss

# 使用 yarn
$ yarn create nextron-app MY_APP --example with-tailwindcss

# 使用 pnpm
$ pnpm dlx create-nextron-app MY_APP --example with-tailwindcss

在开发模式下运行 Electron

运行 npm run dev，nextron 将自动启动 Electron 应用。

{
  "scripts": {
    "dev": "nextron"
  }
}

生产构建

运行 npm run build，nextron 将在 dist 文件夹下输出打包好的程序。

{
  "scripts": {
    "build": "nextron build"
  }
}

基本目录结构

.
├── main
│   ├── background.ts
│   └── preload.ts
├── renderer
│   ├── next.config.js
│   ├── pages
│   │   ├── home.tsx
│   │   └── next.tsx
│   ├── preload.d.ts
│   ├── public
│   │   └── images
│   │       └── logo.png
│   └── tsconfig.json
├── resources
│   ├── icon.icns
│   └── icon.ico
├── nextron.config.js
├── electron-builder.yml
├── package.json
├── tsconfig.json
└── README.md

next.config.js

// 在 `./renderer/next.config.js` 中
module.exports = {
  // 我们需要导出静态文件以便 Electron 处理它们
  output: 'export',

  distDir:
    process.env.NODE_ENV === 'production'
      ? // 我们想在生产模式下将 `distDir` 更改为 "../app"，以便 nextron 可以构建应用！
        '../app'
      : // 默认 `distDir` 值
        '.next',

  // 例如 home.html => home/index.html
  trailingSlash: true,

  // 我们需要禁用图像优化，因为它与 `{ output: 'export' }` 不兼容
  images: {
    unoptimized: true,
  },

  // next.js 的 webpack 配置
  webpack: (config) => {
    return config
  },
}

nextron 或 nextron dev 选项

--renderer-port（默认：8888）

指定 next 开发服务器端口：

{
  "scripts": {
    "dev": "nextron --renderer-port 7777"
  }
}

--run-only（默认：undefined）

禁止主进程的热重载：

{
  "scripts": {
    "dev": "nextron --run-only"
  }
}

--startup-delay（默认：0）

等待渲染进程准备就绪（毫秒）：

{
  "scripts": {
    "dev": "nextron --startup-delay 3000"
  }
}

--electron-options（默认：undefined）

我们可以通过 --electron-options 传递 Electron 参数：

{
  "scripts": {
    "dev": "nextron --electron-options=\"--no-sandbox\""
  }
}

nextron build 选项

注意：

要构建 Windows 32 位版本，请运行 npm run build:win32，如下所示：

{
  "scripts": {
    "build": "nextron build",
    "build:mac": "nextron build --mac",
    "build:mac:universal": "nextron build --mac --universal",
    "build:linux": "nextron build --linux",
    "build:win32": "nextron build --win --ia32",
    "build:win64": "nextron build --win --x64"
  }
}

--config（默认：./electron-builder.yml）

{
  "scripts": {
    "build": "nextron build --config ./configs/electron-builder.prod.yml"
  }
}

--publish（默认：undefined）

注意

强烈建议使用 electron-builder.yml：

https://www.electron.build/configuration/publish

--no-pack（默认：undefined）

此选项跳过 electron-builder 的打包：

{
  "scripts": {
    "build": "nextron build --no-pack"
  }
}

构建配置：electron-builder.yml

编辑 electron-builder.yml 以自定义构建配置：

appId: com.example.nextron
productName: My Nextron App
copyright: Copyright © 2020 Yoshihide Shiono
directories:
  output: dist
  buildResources: resources
files:
  - from: .
    filter:
      - package.json
      - app
publish: null # 参见 https://www.electron.build/configuration/publish

更多信息，请查看 electron-builder 官方配置文档。

自定义配置：nextron.config.js

module.exports = {
  // 指定备用的主源目录，默认为 'main'
  mainSrcDir: 'main',
  // 指定备用的渲染器源目录，默认为 'renderer'
  rendererSrcDir: 'renderer',

  // 主进程的 webpack 配置
  webpack: (config, env) => {
    // 在这里进行一些配置
    return config
  },
}

主进程的自定义 Babel 配置

我们可以通过在项目根目录放置 .babelrc 来扩展主进程的默认 babel 配置，如下所示：

.babelrc:

{
  "presets": ["nextron/babel"]
}

示例

examples/basic-lang-javascript

<p align="center"><img src="https://i.imgur.com/X7dSE68.png"></p> 
# 使用 npx
$ npx create-nextron-app my-app --example basic-lang-javascript

# 使用 yarn
$ yarn create nextron-app my-app --example basic-lang-javascript

# 使用 pnpm
$ pnpm dlx create-nextron-app my-app --example basic-lang-javascript

examples/basic-lang-javascript-python

<p align="center"><img src="https://i.imgur.com/RzAykrU.png"></p> 
# 使用 npx
$ npx create-nextron-app my-app --example basic-lang-javascript-python

# 使用 yarn
$ yarn create nextron-app my-app --example basic-lang-javascript-python

# 使用 pnpm
$ pnpm dlx create-nextron-app my-app --example basic-lang-javascript-python

examples/basic-lang-typescript

<p align="center"><img src="https://i.imgur.com/NZfsD1p.png"></p> 
# 使用 npx
$ npx create-nextron-app my-app --example basic-lang-typescript

# 使用 yarn
$ yarn create nextron-app my-app --example basic-lang-typescript

# 使用 pnpm
$ pnpm dlx create-nextron-app my-app --example basic-lang-typescript

examples/basic-launch-app-from-url

此示例展示如何从浏览器 URL 打开您的应用。

注意：此示例仅适用于生产构建！

<p align="center"><img src="https://yellow-cdn.veclightyear.com/835a84d5/759e7b24-b1f8-41a4-bc24-50716da9641e.gif"></p> 
# 使用 npx
$ npx create-nextron-app my-app --example basic-launch-app-from-url

# 使用 yarn
$ yarn create nextron-app my-app --example basic-launch-app-from-url

# 使用 pnpm
$ pnpm dlx create-nextron-app my-app --example basic-launch-app-from-url

# --------------------------------------------------------------

# 生产构建
$ yarn build (或 `npm run build` 或 `pnpm run build`)

生产构建完成后，在浏览器中打开 your-custom-protocol://open?token=jwt-value，应用将神奇地显示出来！

如果您想更改协议 URL，请编辑 electron-builder.yml#protocols：

protocols:
  name: Your App Name
  schemes: [your-custom-protocol-edited]

然后，您可以通过 URL 看到应用：your-custom-protocol-edited://any-uri-here?data=include-any-data。

examples/basic-store-data

<p align="center"><img src="https://i.imgur.com/BgFze6G.png"></p> 
# 使用 npx
$ npx create-nextron-app my-app --example basic-store-data

# 使用 yarn
$ yarn create nextron-app my-app --example basic-store-data

# 使用 pnpm
$ pnpm dlx create-nextron-app my-app --example basic-store-data

examples/custom-build-options

<p align="center"><img src="https://i.imgur.com/QqQekRJ.png"></p> 
# 使用 npx
$ npx create-nextron-app my-app --example custom-build-options

# 使用 yarn
$ yarn create nextron-app my-app --example custom-build-options

# 使用 pnpm
$ pnpm dlx create-nextron-app my-app --example custom-build-options

examples/custom-renderer-port

<p align="center"><img src="https://i.imgur.com/X7dSE68.png"></p> 
# 使用 npx
$ npx create-nextron-app my-app --example custom-renderer-port

# 使用 yarn
$ yarn create nextron-app my-app --example custom-renderer-port
# 使用 pnpm
$ pnpm dlx create-nextron-app my-app --example custom-renderer-port

examples/with-ant-design

<p align="center"><img src="https://i.imgur.com/NrkTPe9.png"></p> 
# 使用 npx
$ npx create-nextron-app my-app --example with-ant-design

# 使用 yarn
$ yarn create nextron-app my-app --example with-ant-design

# 使用 pnpm
$ pnpm dlx create-nextron-app my-app --example with-ant-design

examples/with-chakra-ui

<p align="center"> <img src="https://i.imgur.com/oahHuxG.png"> <img src="https://i.imgur.com/sZ01Nyl.png"> </p> 
# 使用 npx
$ npx create-nextron-app my-app --example with-chakra-ui

# 使用 yarn
$ yarn create nextron-app my-app --example with-chakra-ui

# 使用 pnpm
$ pnpm dlx create-nextron-app my-app --example with-chakra-ui

examples/with-emotion

<p align="center"><img src="https://i.imgur.com/3UKgyH7.png"></p> 
# 使用 npx
$ npx create-nextron-app my-app --example with-emotion

# 使用 yarn
$ yarn create nextron-app my-app --example with-emotion

# 使用 pnpm
$ pnpm dlx create-nextron-app my-app --example with-emotion

examples/with-material-ui

<p align="center"><img src="https://i.imgur.com/flcMvDC.png"></p> 
# 使用 npx
$ npx create-nextron-app my-app --example with-material-ui

# 使用 yarn
$ yarn create nextron-app my-app --example with-material-ui

# 使用 pnpm
$ pnpm dlx create-nextron-app my-app --example with-material-ui

examples/with-next-i18next

<p align="center"><img src="https://i.imgur.com/uhXCr6v.png"></p> 
# 使用 npx
$ npx create-nextron-app my-app --example with-next-i18next

# 使用 yarn
$ yarn create nextron-app my-app --example with-next-i18next

# 使用 pnpm
$ pnpm dlx create-nextron-app my-app --example with-next-i18next

examples/with-tailwindcss

<p align="center"><img src="https://i.imgur.com/a9QWW0v.png"></p> 
# 使用 npx
$ npx create-nextron-app my-app --example with-tailwindcss

# 使用 yarn
$ yarn create nextron-app my-app --example with-tailwindcss

# 使用 pnpm
$ pnpm dlx create-nextron-app my-app --example with-tailwindcss

开发

基础

$ git clone https://github.com/saltyshiomix/nextron.git
$ cd nextron
$ pnpm install
$ pnpm dev # 默认是 examples/basic-lang-javascript

开发 examples/*

$ pnpm dev <示例文件夹名称>

为你自己的项目开发

  1. 安装 nextron 的开发版本
$ cd nextron
$ npm install
$ npm run build
$ npm link
  1. 在你的项目中安装链接的 nextron
$ cd your-project
$ npm link nextron
  1. 每次在 nextron 文件夹中修改后，运行 npm run build，然后重启你的项目

维护者 ⚡

更多信息，请查看 寻找维护者 ⚡ #244。

社区

你已经使用 nextron 创建了应用程序吗？欢迎分享你的应用或服务：使用 nextron 制作？ #406

相关

许可证

本项目采用 MIT 许可证 的条款授权。

编辑推荐精选

TRAE编程

TRAE编程

AI辅助编程，代码自动修复

Trae是一种自适应的集成开发环境（IDE），通过自动化和多元协作改变开发流程。利用Trae，团队能够更快速、精确地编写和部署代码，从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能，是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
蛙蛙写作

蛙蛙写作

AI小说写作助手，一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台，涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能，助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
问小白

问小白

全能AI智能助手，随时解答生活与工作的多样问题

问小白，由元石科技研发的AI智能助手，快速准确地解答各种生活和工作问题，包括但不限于搜索、规划和社交互动，帮助用户在日常生活中提高效率，轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手，它拥有超精准的音频识别翻译能力，几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球，无论你是留学生、商务人士、韩剧美剧爱好者，还是出国游玩、多国会议、跨国追星等等，都可以满足你所有需要同传的场景需求，线上线下通用，扫除语言障碍，让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word，让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目，能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定，还是学生群体的职业生涯规划、实习避坑指南，亦或是活动策划、旅游攻略等内容，它都能提供支持，帮助用户精准表达，轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级，全面对标OpenAI o1

科大讯飞的星火大模型，支持语言理解、知识问答和文本创作等多功能，适用于多种文件和业务场景，提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台，涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能，能为不同需求的用户提供便捷高效的帮助，助力用户轻松获取信息、解决问题，满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目，由多个知名机构联合参与。该项目提供了高效的 LLM（大语言模型）驱动的语音合成方案，支持语音克隆和语音创建功能，可通过命令行界面（CLI）和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数，生成高质量的语音。该项目适用于多种场景，如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力，做PPT更简单！

咔片是一款轻量化在线演示设计工具，借助 AI 技术，实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT，提供海量模板、智能美化、素材替换等功能，适用于销售、教师、学生等各类人群，能高效制作出高品质 PPT，满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文，一站式创作，让内容运营更高效

讯飞绘文，一个AI集成平台，支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容，加速品牌传播，提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台，公文写作神器

AI 材料星，专业的 AI 公文写作辅助平台，为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能，支持 30 + 文稿类型生成，助力快速完成领导讲话、工作总结、述职报告等材料，提升办公效率，是体制打工人的得力写作神器。

下拉加载更多