archive/rsnext
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rsnext/examples/gh-pages
History
Ronald Stevanus b3c9737445
Fix gh-pages deploy script (#15724) 
## What

The current `gh-pages` example has issue when deploying. 

This is how the error looks like:
![image](https://user-images.githubusercontent.com/1008093/88996697-827f0c80-d320-11ea-93bd-48141c321a65.png)

```
...
Export successful
The following paths are ignored by one of your .gitignore files:
out
hint: Use -f if you really want to add them.
hint: Turn this message off by running
hint: "git config advice.addIgnoredFile false"
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! next@1.0.0 deploy: `rm -rf node_modules/.cache && next build && next export && touch out/.nojekyll && git add out/`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the next@1.0.0 deploy script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
...
```

It's because `out` folder is added on `.gitignore` and the deploy script runs `git add out/`.
The fix is to remove `out` folder from `.gitignore`.

## How was it tested
run `npm run deploy`, it should be completed successfully.
2020-07-31 16:25:17 +00:00
..
pages Update Examples for Fast Refresh (#13068) 2020-05-18 17:44:18 -04:00
.babelrc.js Improve linting rules to catch more errors (#9374) 2019-11-10 19:24:53 -08:00
.gitignore Fix gh-pages deploy script (#15724) 2020-07-31 16:25:17 +00:00
env-config.js Improve linting rules to catch more errors (#9374) 2019-11-10 19:24:53 -08:00
next.config.js Remove unnecessary exportPathMap from examples (#10218) 2020-01-22 22:06:07 +01:00
package.json Test updater script on examples folder (#5993) 2019-01-05 12:19:27 +01:00
README.md Suggest npx over npm init (#13637) 2020-06-01 17:36:57 +00:00

README.md

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:

npx create-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/vercel/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.

  1. Create repository.
  2. Link it to your github account.
  3. 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/