History

Tanmay Laud f00ad581a1 Added .gitignore to examples that are deployed to vercel (#15127 ) Co-authored-by: Joe Haddad <joe.haddad@zeit.co>		2020-07-16 10:52:23 -04:00
..
src	[Examples] Update with-chakra-ui (#14035 )	2020-06-11 01:34:41 -05:00
.gitignore	Added .gitignore to examples that are deployed to vercel (#15127 )	2020-07-16 10:52:23 -04:00
package.json	Add `with-chakra-ui` example (#10033 )	2020-01-10 11:24:39 -05:00
README.md	Suggest `npx` over `npm init` (#13637 )	2020-06-01 17:36:57 +00:00

README.md

Example app with chakra-ui

This example features how to use chakra-ui as the component library within a Next.js app.

We are connecting the Next.js _app.js with chakra-ui's Theme and ColorMode containers so the pages can have app-wide dark/light mode. We are also creating some components which shows the usage of chakra-ui's style props.

Deploy your own

Deploy the example using Vercel:

How to use

Using `create-next-app`

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

npx create-next-app --example with-chakra-ui with-chakra-ui-app
# or
yarn create next-app --example with-chakra-ui with-chakra-ui-app

Download manually

Download the example:

curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-chakra-ui
cd with-chakra-ui

Install it and run:

npm install
npm run dev
# or
yarn
yarn dev

Deploy it to the cloud with Vercel (Documentation).