Commit c44dab63 authored by Henrik Wenz's avatar Henrik Wenz Committed by Tim Neutkens

Add with-yarn-workspaces example (#5034)

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

- [x] Tested in development mode
- [x] Tested in production mode
- [x] Tested with deployment https://with-yarn-workspaces-hwzubdlkul.now.sh/
- [x] Added transpile module example

Closes #3638 
parent 52a4dfc8
[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/zeit/next.js/tree/master/examples/with-yarn-workspaces)
# Yarn workspaces example
## How to use
### Using `create-next-app`
Execute [`create-next-app`](https://github.com/segmentio/create-next-app) with [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) or [npx](https://github.com/zkat/npx#readme) to bootstrap the example:
```bash
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:
```bash
curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-yarn-workspaces
cd with-yarn-workspaces
```
Install it and run:
```bash
yarn
yarn dev
```
Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download))
```bash
now
```
## The idea behind the 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](./packages/web-app/next.config.js) for more info)
## Useful Links
* [Documentation](https://yarnpkg.com/en/docs/workspaces)
* [yarn workspaces](https://yarnpkg.com/lang/en/docs/cli/workspace)
* [yarn workspace](https://yarnpkg.com/lang/en/docs/cli/workspaces)
* [next-plugin-transpile-modules](https://www.npmjs.com/package/next-plugin-transpile-modules)
{
"private": true,
"workspaces": ["packages/*"],
"scripts": {
"dev": "yarn --cwd packages/web-app dev",
"build": "yarn --cwd packages/web-app build",
"start": "yarn --cwd packages/web-app start"
}
}
import React from 'react'
const Bar = () => (
<strong>
bar
</strong>
)
export default Bar
{
"name": "bar",
"version": "1.0.0",
"license": "ISC",
"peerDependencies": {
"react": "^16.0.0"
}
}
{
"name": "foo",
"version": "1.0.0",
"license": "ISC"
}
const withTM = require('next-plugin-transpile-modules')
// Tell webpack to compile the "bar" package
// https://www.npmjs.com/package/next-plugin-transpile-modules
module.exports = withTM({
transpileModules: ['bar']
})
{
"name": "web-app",
"version": "1.0.0",
"scripts": {
"dev": "next",
"build": "next build",
"start": "next start"
},
"dependencies": {
"next": "latest",
"next-plugin-transpile-modules": "0.1.1",
"react": "^16.0.0",
"react-dom": "^16.0.0"
},
"license": "ISC"
}
import foo from 'foo'
import Bar from 'bar'
export default () => (
<div>
Imported modules from another workspace:
<pre>{foo}</pre>
<Bar />
</div>
)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment