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

Raw Blame History

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

How to use

Using `create-next-app`

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

npm init next-app --example gh-pages gh-pages-app
# or
yarn create next-app --example gh-pages gh-pages-app

Download manually

Download the example:

curl https://codeload.github.com/zeit/next.js/tar.gz/master | tar -xz --strip=2 next.js-master/examples/gh-pages
cd gh-pages

Install it and run:

npm install
npm run dev
# or
yarn
yarn dev

Deploy it to github

Edit env-config.js and replace 'Next-gh-page-example' by your project name.

Edit next.config.js and replace 'Next-gh-page-example' by your project name.

Create repository.
Link it to your github account.
Publish your master branch.

npm run deploy

Test it:

Replace <github-user-name> and <github-project-name>

https://<github-user-name>.github.io/<github-project-name>/

Example:

https://github.com/thierryc/Next-gh-page-example/

https://thierryc.github.io/Next-gh-page-example/

1.5 KiB Raw Blame History