rsnext/examples/with-electron/README.md

26 lines
1.1 KiB
Markdown
Raw Normal View History

# Electron application example
2020-12-08 03:29:00 +01:00
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.
2020-12-08 03:29:00 +01:00
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](https://leo.im/2017/electron-next)!**
2017-08-19 16:37:09 +02:00
## How to use
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) 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`.