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 | ||
| pages | ||
| public | ||
| styles | ||
| .env.local.example | ||
| .gitignore | ||
| package.json | ||
| README.md | ||
Clerk and Next.js Example
This example shows how to use Clerk with Next.js. The example features adding sign up, sign in, profile management, and an authenticated API route to your Next.js application.
Demo
A hosted demo of this example is available at clerk-nextjs-example.vercel.app
Deploy your own
Deploy the example using Vercel:
How to use
Execute create-next-app with npm or Yarn to bootstrap the example:
npx create-next-app --example with-clerk with-clerk-app
# or
yarn create next-app --example with-clerk with-clerk-app
# or
pnpm create next-app -- --example with-clerk with-clerk-app
To run the example locally you need to:
- Sign up at Clerk.dev.
- Go to Clerk's dashboard and create an application.
- Set the required Clerk environment variables from your Clerk project as shown at the example env file.
yarnto install the required dependencies.yarn devto launch the development server.
Learn More
To learn more about Clerk.dev and Next.js, take a look at the following resources:
- Quick start
- Clerk.dev Documentation - learn about Clerk.dev features and API.
- Next.js Documentation - learn about Next.js features and API.