Back to Next Js

Electron application example

examples/with-electron/README.md

16.2.51.1 KB
Original Source

Electron application example

This example shows how you can use Next.js inside an Electron application to avoid a lot of configuration. It uses the Next.js router as view and server-render to speed up the initial render of the application.

For development it's going to run an HTTP server and let Next.js handle routing. In production it uses output: 'export' to pre-generate HTML static files and uses them in your app instead of running an HTTP server.

For detailed documentation about how to build Electron apps with Next.js, see this blog post!

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

bash
npx create-next-app --example with-electron with-electron-app
bash
yarn create next-app --example with-electron with-electron-app
bash
pnpm create next-app --example with-electron with-electron-app

You can create the production app using npm run dist.