Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

examples: improve DX while copying command to create new project #73463

Merged
merged 1 commit into from
Jan 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions examples/blog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example blog my-blog
# or
```

```bash
yarn create next-app --example blog my-blog
# or
```

```bash
pnpm create next-app --example blog my-blog
```

Expand Down
8 changes: 6 additions & 2 deletions examples/cms-dotcms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example cms-dotcms cms-dotcms-app
# or
```

```bash
yarn create next-app --example cms-dotcms cms-dotcms-app
# or
```

```bash
pnpm create next-app --example cms-dotcms cms-dotcms-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/cms-enterspeed/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example cms-enterspeed enterspeed-app
# or
```

```bash
yarn create next-app --example cms-enterspeed enterspeed-app
# or
```

```bash
pnpm create next-app -- --example cms-enterspeed enterspeed-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/cms-makeswift/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,13 @@ Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_mediu

```bash
npx create-next-app --example cms-makeswift cms-makeswift-app
# or
```

```bash
yarn create next-app --example cms-makeswift cms-makeswift-app
# or
```

```bash
pnpm create next-app --example cms-makeswift cms-makeswift-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/cms-umbraco/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example cms-umbraco umbraco-app
# or
```

```bash
yarn create next-app --example cms-umbraco umbraco-app
# or
```

```bash
pnpm create next-app --example cms-umbraco umbraco-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/convex/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example convex convex-app
# or
```

```bash
yarn create next-app --example convex convex-app
# or
```

```bash
pnpm create next-app --example convex convex-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/custom-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,12 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example custom-server custom-server-app
# or
```

```bash
yarn create next-app --example custom-server custom-server-app
# or
```

```bash
pnpm create next-app --example custom-server custom-server-app
```
8 changes: 6 additions & 2 deletions examples/image-component/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example image-component image-app
# or
```

```bash
yarn create next-app --example image-component image-app
# or
```

```bash
pnpm create next-app --example image-component image-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/image-legacy-component/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example image-legacy-component image-app
# or
```

```bash
yarn create next-app --example image-legacy-component image-app
# or
```

```bash
pnpm create next-app --example image-legacy-component image-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/progressive-web-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example progressive-web-app progressive-web-app
# or
```

```bash
yarn create next-app --example progressive-web-app progressive-web-app
# or
```

```bash
pnpm create next-app --example progressive-web-app progressive-web-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/with-axiom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example with-axiom with-axiom-app
# or
```

```bash
yarn create next-app --example with-axiom with-axiom-app
# or
```

```bash
pnpm create next-app --example with-axiom with-axiom-app
```

Expand Down
8 changes: 7 additions & 1 deletion examples/with-contentlayer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,14 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example with-contentlayer with-contentlayer-app
# or
```

```bash
yarn create next-app --example with-contentlayer with-contentlayer-app
```

```bash
pnpm create next-app --example with-contentlayer with-contentlayer-app
```

Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
10 changes: 8 additions & 2 deletions examples/with-cookies-next/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,18 @@ Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_mediu

## How to use

Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:

```bash
npx create-next-app --example with-cookies-next with-cookies-next-app
# or
```

```bash
yarn create next-app --example with-cookies-next with-cookies-next-app
```

```bash
pnpm create next-app --example with-cookies-next with-cookies-next-app
```

Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
8 changes: 6 additions & 2 deletions examples/with-docker-multi-env/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example with-docker-multi-env nextjs-docker-multi-env
# or
```

```bash
yarn create next-app --example with-docker-multi-env nextjs-docker-multi-env
# or
```

```bash
pnpm create next-app --example with-docker-multi-env nextjs-docker-multi-env
```

Expand Down
8 changes: 6 additions & 2 deletions examples/with-docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example with-docker nextjs-docker
# or
```

```bash
yarn create next-app --example with-docker nextjs-docker
# or
```

```bash
pnpm create next-app --example with-docker nextjs-docker
```

Expand Down
8 changes: 6 additions & 2 deletions examples/with-mysql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example with-mysql nextjs-mysql
# or
```

```bash
yarn create next-app --example with-mysql nextjs-mysql
# or
```

```bash
pnpm create next-app --example with-mysql nextjs-mysql
```

Expand Down
8 changes: 6 additions & 2 deletions examples/with-next-seo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example with-next-seo next-seo-app
# or
```

```bash
yarn create next-app --example with-next-seo next-seo-app
# or
```

```bash
pnpm create next-app --example with-next-seo next-seo-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/with-next-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example with-next-ui with-next-ui-app
# or
```

```bash
yarn create next-app --example with-next-ui with-next-ui-app
# or
```

```bash
pnpm create next-app --example with-next-ui with-next-ui-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/with-nhost-auth-realtime-graphql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example with-nhost-auth-realtime-graphql nhost-app
# or
```

```bash
yarn create next-app --example with-nhost-auth-realtime-graphql nhost-app
# or
```

```bash
pnpm create next-app --example with-nhost-auth-realtime-graphql nhost-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/with-particles/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example with-particles with-particles-app
# or
```

```bash
yarn create next-app --example with-particles with-particles-app
# or
```

```bash
pnpm create next-app -- --example with-particles with-particles-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/with-redis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example with-redis roadmap
# or
```

```bash
yarn create next-app --example with-redis roadmap
# or
```

```bash
pnpm create next-app --example with-redis roadmap
```

Expand Down
8 changes: 6 additions & 2 deletions examples/with-sentry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,13 @@ To begin, execute [`create-next-app`](https://github.com/vercel/next.js/tree/can

```bash
npx create-next-app --example with-sentry nextjs-sentry-example
# or
```

```bash
yarn create next-app --example with-sentry nextjs-sentry-example
# or
```

```bash
pnpm create next-app --example with-sentry nextjs-sentry-example
```

Expand Down
2 changes: 1 addition & 1 deletion examples/with-sfcc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Check out our [Next.js deployment documentation](https://nextjs.org/docs/deploym
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:

```bash
npx create-next-app --example with-sfcc nextjs-sfcc-app
npx create-next-app --example with-sfcc nextjs-sfcc-app
```

```bash
Expand Down
12 changes: 10 additions & 2 deletions examples/with-supabase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,21 @@ If you wish to just develop locally and not deploy to Vercel, [follow the steps
2. Create a Next.js app using the Supabase Starter template npx command

```bash
npx create-next-app -e with-supabase
npx create-next-app --example with-supabase with-supabase-app
```

```bash
yarn create next-app --example with-supabase with-supabase-app
```

```bash
pnpm create next-app --example with-supabase with-supabase-app
```

3. Use `cd` to change into the app's directory

```bash
cd name-of-new-app
cd with-supabase-app
```

4. Rename `.env.example` to `.env.local` and update the following:
Expand Down
Loading
Loading