rsnext/examples/with-electron
Steven 9f9214abe5
Updated create-next-app docs to include pnpm usage (#35755)
This PR updates the docs and examples for `create-next-app` to include pnpm usage.

The following script was used to update every example README:

```js
const fs = require('fs')
const examples = fs.readdirSync('./examples')

for (let example of examples) {
    const filename = `./examples/${example}/README.md`
    const markdown = fs.readFileSync(filename, 'utf8')
    const regex = new RegExp(`^yarn create next-app --example (.*)$`, 'gm')
    const output = markdown.replace(regex, (yarn, group) => {
        const pnpm = `pnpm create next-app -- --example ${group}`
        return `${yarn}\n# or\n${pnpm}`
    })
    fs.writeFileSync(filename, output)
}
```
2022-03-30 21:03:21 +00:00
..
main Update with-electron example (#23873) 2021-04-11 15:38:15 +00:00
renderer Update with-electron example (#23873) 2021-04-11 15:38:15 +00:00
.gitignore examples: Update with-electron .gitignore (#15783) 2020-08-02 08:14:48 +00:00
package.json Remove licence from all example/package.json that has them (#28007) 2021-08-14 10:48:39 -05:00
README.md Updated create-next-app docs to include pnpm usage (#35755) 2022-03-30 21:03:21 +00:00

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 or Yarn 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
# or
pnpm create next-app -- --example with-electron with-electron-app

You can create the production app using npm run dist.