Shu Uesugi 6804039e94 Make example READMEs more consistent (#10124 )

* npx create → npm init

* Fix inconsistent instructions

* Update amp-first

* Update with-graphql-react

* with-firebase-cloud-messaging

* Update with-higher-order-component

* change create-next-app url

* Update create-next-app instruction

* Update instructions to use npm instead of npx

* Move "the idea behind the example" to top

* Rename

* Rename

* Update contributing.md with a README template

2020-01-16 23:23:56 +01:00

1.8 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 ZEIT Now:

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/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:

yarn
yarn dev

Deploy it to the cloud with now (download):

now

1.8 KiB Raw Blame History Unescape Escape