rsnext/examples/with-electron
Shu Uesugi 6804039e94 Make example READMEs more consistent (#10124)
* npx create → npm init

* Fix inconsistent instructions

* Update amp-first

* Update with-graphql-react

* with-firebase-cloud-messaging

* Update with-higher-order-component

* change create-next-app url

* Update create-next-app instruction

* Update instructions to use npm instead of npx

* Move "the idea behind the example" to top

* Rename

* Rename

* Update contributing.md with a README template
2020-01-16 23:23:56 +01:00
..
main Fix source in electron build (#9802) 2019-12-21 13:25:27 -06:00
renderer Fix source in electron build (#9802) 2019-12-21 13:25:27 -06:00
package.json Fix source in electron build (#9802) 2019-12-21 13:25:27 -06:00
README.md Make example READMEs more consistent (#10124) 2020-01-16 23:23:56 +01:00

Electron application example

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

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

You can find a detailed documentation about how to build Electron apps with Next.js here!

How to use

Using create-next-app

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

npm init next-app --example with-electron with-electron-app
# or
yarn create next-app --example with-electron with-electron-app

Download manually

Download the example:

curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-electron
cd with-electron

Install it and run:

npm install
npm run start
# or
yarn
yarn start

You can create the production app using npm run dist.