rsnext/examples/using-preact
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
..
pages Update using-preact example's dependencies (#18493) 2020-10-29 22:52:27 +00:00
.gitignore Added .gitignore to examples that are deployed to vercel (#15127) 2020-07-16 10:52:23 -04:00
next.config.js feat(examples): use next-plugin-preact on using-preact example (#18588) 2020-11-05 16:56:58 +00:00
package.json Change using-preact example dependencies and docs (#30394) 2021-12-11 15:19:49 +01:00
README.md Updated create-next-app docs to include pnpm usage (#35755) 2022-03-30 21:03:21 +00:00

Preact example

This example uses Preact instead of React. It's a React like UI framework which is fast and small.

Deploy your own

Deploy the example using Vercel or preview live with StackBlitz

Deploy with Vercel

How to use

Execute create-next-app with npm or Yarn to bootstrap the example:

npx create-next-app --example using-preact using-preact-app
# or
yarn create next-app --example using-preact using-preact-app
# or
pnpm create next-app -- --example using-preact using-preact-app

Deploy it to the cloud with Vercel (Documentation).

Aliasing react -> preact

Using preact with next.js depends on aliasing react packages to preact ones (like @preact/compat). This is done directly in the package.json dependencies.

next-plugin-preact

This example was updated to use next-plugin-preact and now requires minimal configuration, if you want to add preact without a plugin, or see how it works, head to the previous next.config.js.