rsnext/examples/with-yarn-workspaces
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +00:00
..
packages Update Examples to use React 18 (#42027) 2022-10-28 17:43:20 +00:00
.gitignore Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
package.json Remove licence from all example/package.json that has them (#28007) 2021-08-14 10:48:39 -05:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -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 or preview live with StackBlitz

Deploy with Vercel

How to use

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

npx create-next-app --example with-yarn-workspaces with-yarn-workspaces-app
yarn create next-app --example with-yarn-workspaces with-yarn-workspaces-app
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.