rsnext/examples/with-yarn-workspaces
JJ Kasper 1f6ce106ae
Update codeload and deploy links for org rename (#13141)
Co-authored-by: Joe Haddad <joe.haddad@zeit.co>
2020-05-27 14:11:39 -04:00
..
packages chore: Remove some redundant imports (#13066) 2020-05-20 05:23:16 +00:00
now.json [Examples] Fix with-yarn-workspaces Vercel deploy button (#12867) 2020-05-20 04:39:38 +00:00
package.json Move syntax formatting to prettier (#7454) 2019-05-29 13:57:26 +02:00
README.md Update codeload and deploy links for org rename (#13141) 2020-05-27 14:11:39 -04:00

Yarn workspaces example

Workspaces are a new way to setup your package architecture thats 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:

Deploy with Vercel

How to use

Using create-next-app

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

npm init 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.