rsnext/examples/with-electron/README.md
Marcos Bérgamo c3e5caf110
docs(examples): improve DX while copying command to create new project (#38410)
* docs(examples): improve DX while copy command to create new project

* chore: apply code review

Co-authored-by: Marcos Bérgamo <Marcos.Bergamo@refinitiv.com>
Co-authored-by: JJ Kasper <jj@jjsweb.site>
2022-07-26 21:57:48 -05:00

1.1 KiB

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 next 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:

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

You can create the production app using npm run dist.