rsnext/examples/with-slate/README.md

40 lines
1.2 KiB
Markdown
Raw Normal View History

2018-08-07 06:00:31 +02:00
# slate.js example
This example shows how to use Next.js along with [Slate.js](https://www.slatejs.org/).
## Deploy your own
Deploy the example using [Vercel](https://vercel.com):
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/vercel/next.js/tree/canary/examples/with-slate)
2018-08-07 06:00:31 +02:00
## How to use
### Using `create-next-app`
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example::
2018-08-07 06:00:31 +02:00
```bash
npm init next-app --example with-slate with-slate-app
2018-08-07 06:00:31 +02:00
# or
yarn create next-app --example with-slate with-slate-app
```
### Download manually
Download the example [or clone the repo](https://github.com/vercel/next.js):
2018-08-07 06:00:31 +02:00
```bash
curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-slate
2018-08-07 06:00:31 +02:00
cd with-slate
```
Install it and run:
```bash
npm install
npm run dev
```
Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).