History

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
..
pages	Improve linting rules to catch more errors (#9374 )	2019-11-10 19:24:53 -08:00
package.json	Test updater script on examples folder (#5993 )	2019-01-05 12:19:27 +01:00
README.md	Make example READMEs more consistent (#10124 )	2020-01-16 23:23:56 +01:00

README.md

Hello World example

This example shows the most basic idea behind Next. We have 2 pages: pages/index.js and pages/about.js. The former responds to / requests and the latter to /about. Using next/link you can add hyperlinks between them with universal routing capabilities. The day directory shows that you can have subdirectories.

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 hello-world hello-world-app
# or
yarn create next-app --example hello-world hello-world-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/hello-world
cd hello-world

Install it and run:

npm install
npm run dev
# or
yarn
yarn dev

Deploy it to the cloud with now (download):

now