Suggest npx over npm init (#13637 )

This updates old examples to the more universal `npx` command.

Fixes https://github.com/vercel/next.js/discussions/12103

2020-06-01 17:36:57 +00:00

2 KiB

Raw Blame History

Yarn workspaces example

Workspaces are a new way to setup your package architecture that’s available by default starting from Yarn 1.0. It allows you to setup multiple packages in such a way that you only need to run yarn install once to install all of them in a single pass.

In this example we have three workspaces:

web-app: A Next.js app
foo: A normal node module
bar: A react component, that gets compiled by Next.js (see packages/web-app/next.config.js for more info)

Deploy your own

Deploy the example using Vercel:

How to use

Using `create-next-app`

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

npx create-next-app --example with-yarn-workspaces with-yarn-workspaces-app
# or
yarn create next-app --example with-yarn-workspaces with-yarn-workspaces-app

Download manually

Download the example:

curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-yarn-workspaces
cd with-yarn-workspaces

Install it and run:

yarn
yarn dev

Deploy it to the cloud with Vercel (Documentation).

Choose packages/web-app as root directory when deploying.

2 KiB Raw Blame History Unescape Escape