9f9214abe5
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)
}
```
|
||
|---|---|---|
| .. | ||
| components | ||
| machines | ||
| pages | ||
| .gitignore | ||
| package.json | ||
| README.md | ||
XState example
This example shows how to integrate XState in Next.js. Learn more about XState.
Deploy your own
Deploy the example using Vercel or preview live with StackBlitz
How to use
Execute create-next-app with npm or Yarn to bootstrap the example:
npx create-next-app --example with-xstate with-xstate-app
# or
yarn create next-app --example with-xstate with-xstate-app
# or
pnpm create next-app -- --example with-xstate with-xstate-app
Inspect your machines using @xstate/inspect
You could use the inspection tools for XState: (@xstate/inspect) to debug and visualize your machines in development mode.
Install @xstate/inspect
npm install @xstate/inspect
# or
yarn add @xstate/inspect
Import it at the top of the project
import { inspect } from '@xstate/inspect'
Use the inspect method
Note that for Next.js projects, you should ensure that the inspector code only runs on the client, rather than the server:
if (typeof window !== 'undefined') {
inspect({
/* options */
})
}
Deploy to Now
Deploy it to the cloud with Vercel (Documentation).
References
- xstate repository
- @xstate/react documentation
- @xstate/inspect usage with Next.JS