1
0
Fork 0
mirror of https://github.com/terribleplan/next.js.git synced 2024-01-19 02:48:18 +00:00
next.js/examples/with-electron
James Hegedus b1d8b839dd Examples: use npx and yarn create to run create-next-app on examples (#4002)
* remove global npm install of create-next-app

* add npx to create-next-app command in examples

* add bash to shell snippets

* add yarn create to next-app command in examples

* fix READMEs named with lowercase

* change READMEs to use UPPERCASE
2018-03-14 09:09:46 +01:00
..
main Add Electron example (#1430) 2017-08-09 07:56:23 +02:00
renderer Add Electron example (#1430) 2017-08-09 07:56:23 +02:00
package.json Update Next.js version on examples 2018-01-30 21:46:15 +01:00
README.md Examples: use npx and yarn create to run create-next-app on examples (#4002) 2018-03-14 09:09:46 +01:00

Electron application example

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

How to use

Using create-next-app

Download create-next-app to bootstrap the example:

npx create-next-app --example with-electron with-electron-app
# or
yarn create next-app --example with-electron with-electron-app

Download manually

Download the example or clone the repo:

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 start

The idea behind the 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 create the production app using npm run dist.