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/README.md
Sergio Xalambrí 4b0467ed42 Add Electron example (#1430)
* Add Electron usage example

* Remove the deploy part

* Only allow GET request to our HTTP server

* Only allow request from an electron app (checking the user agent)

* Add warning about the local HTTP server

* Update package.json

* Update example to use Next.js v3

* Added required package.json fields with placeholders

* Use next:// file protocol to open internal built files

* Create next.config.js

* Update set-menu.js

* Update example to merge it with electron-next-skeleton ideas
2017-08-09 07:56:23 +02:00

26 lines
832 B
Markdown

# Electron application example
## How to use
Download the example [or clone the repo](https://github.com/zeit/next.js):
```bash
curl https://codeload.github.com/zeit/next.js/tar.gz/master | tar -xz --strip=2 next.js-master/examples/with-electron
cd with-electron
```
Install it and run:
```bash
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`.