ContextQMD
Back to Next Js

Yarn workspaces example

examples/with-yarn-workspaces/README.md

16.2.51.8 KB
Original Source

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

How to use

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

bash
npx create-next-app --example with-yarn-workspaces with-yarn-workspaces-app
bash
yarn create next-app --example with-yarn-workspaces with-yarn-workspaces-app
bash
pnpm create next-app --example with-yarn-workspaces with-yarn-workspaces-app

Deploy it to the cloud with Vercel (Documentation).

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