rsnext/examples/with-electron
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +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 Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
next.config.js chore(docs): update next export to output: 'export' (#47717) 2023-03-31 02:04:23 +00:00
package.json chore(docs): update next export to output: 'export' (#47717) 2023-03-31 02:04:23 +00:00
README.md chore(docs): update next export to output: 'export' (#47717) 2023-03-31 02:04:23 +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 output: '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, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-electron with-electron-app
yarn create next-app --example with-electron with-electron-app
pnpm create next-app --example with-electron with-electron-app

You can create the production app using npm run dist.