rsnext/examples/with-electron/README.md
John Jago c6ba29da00
docs: use descriptive links instead of "click here" (#25897)
* docs: use descriptive links instead of "click here"

Linking text such as "here" or "click here" is not accessible (and
doesn't look that great either). The best example of why it's better to
use link text that provides context is that some screen readers allow
navigation by links alone. If all links say "click here", then how does
the user know which one to go to?

I tried to make the minimal change necessary to make the link text
descriptive but had to reword a few sentences that didn't read well.

* Apply suggestions from code review

Co-authored-by: Lee Robinson <me@leerob.io>
Co-authored-by: JJ Kasper <jj@jjsweb.site>
2021-06-09 13:23:16 -05:00

1 KiB

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

You can create the production app using npm run dist.