f7baa56792
### What?
Updates Deploy button URLs for all listed examples here:
https://github.com/vercel/next.js/tree/canary/examples
### Why?
The Deploy URLs are currently broken and result in a failed clone
attempt on Vercel.
### How?
The URLs have been changed from https://vercel.com/new/git/external?… to
-> https://vercel.com/new/clone?…
(Last updated
[here](8eaabe2fb0)
in 2021)
54 lines
2.6 KiB
Markdown
54 lines
2.6 KiB
Markdown
# Example app using ReasonML & ReasonReact components
|
|
|
|
This example builds upon the original `with-reasonml` example to show how a
|
|
global state object can be used to track state across page within the application.
|
|
|
|
It is intended to show how to build a simple, stateful application using hooks
|
|
without the added complexity of a redux type library.
|
|
|
|
This example features:
|
|
|
|
- An app that mixes together JavaScript and ReasonML components and functions
|
|
- An app with two pages which has a common Counter component
|
|
- That Counter component maintain the counter inside its module. This is used
|
|
primarily to illustrate that modules get initialized once and their state
|
|
variables persist in runtime
|
|
|
|
## Deploy your own
|
|
|
|
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):
|
|
|
|
[](https://vercel.com/new/clone?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-reasonml-todo&project-name=with-reasonml-todo&repository-name=with-reasonml-todo)
|
|
|
|
## How to use
|
|
|
|
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
|
|
|
|
```bash
|
|
npx create-next-app --example with-reasonml-todo with-reasonml-app
|
|
# or
|
|
yarn create next-app --example with-reasonml-todo with-reasonml-app
|
|
# or
|
|
pnpm create next-app --example with-reasonml-todo with-reasonml-app
|
|
```
|
|
|
|
Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
|
|
|
|
### Recommendation:
|
|
|
|
Run BuckleScript build system `bsb -w` and `next -w` separately. For the sake
|
|
of simple convention, `npm run dev` run both `bsb` and `next` concurrently.
|
|
However, this doesn't offer the full [colorful and very, very, veeeery nice
|
|
error
|
|
output](https://reasonml.github.io/blog/2017/08/25/way-nicer-error-messages.html)
|
|
experience that ReasonML can offer, don't miss it!
|
|
|
|
There are 2 convenience scripts to facilitate running these separate processes:
|
|
|
|
1. `npm run dev:reason` - This script will start the ReasonML toolchain in
|
|
watch mode to re-compile whenever you make changes.
|
|
2. `npm run dev:next` - This script will start the next.js development server
|
|
so that you will be able to access your site at the location output by the
|
|
script. This will also hot reload as you make changes.
|
|
|
|
You should start the scripts in the presented order.
|