mirror of https://github.com/terribleplan/next.js.git synced 2024-01-19 02:48:18 +00:00

James Hegedus f2e56609cd Examples: stabalise README format and create-next-app usage (#4009 )

* Examples: clarify language around Yarn create & npx

* add missing READMEs and create-next-app usage

* suggest people tag jthegedus in firebase related issues

* add yarn alt instructions

* cerebraljs example readme & fixes

2018-04-03 14:19:05 +02:00

1.5 KiB

Raw Blame History

With react-toolbox example

How to use

Using `create-next-app`

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

npx create-next-app --example with-react-toolbox with-react-toolbox-app
# or
yarn create next-app --example with-react-toolbox with-react-toolbox-app

Download manually

Download the example or clone the repo:

curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-react-toolbox
cd with-react-toolbox

Install it and run:

npm install
npm run dev
# or
yarn
yarn dev

Notice that yarn toolbox (or npm run toolbox) should be rerun every time the "reactToolbox" configuration in package.json is changed, in order to update static/theme.js and static/theme.css. The "reactToolbox" configuration includes styling, and the list of react-toolbox components to include.

The idea behind the example

This is a simple example of getting react-toolbox up and running, using react-toolbox-themr.

For actual use, you probably also want to add Roboto Font, and Material Design Icons. See http://react-toolbox.com/#/install

1.5 KiB Raw Blame History