rsnext/examples/with-reasonml-todo
Nathan Sculli fa39b311ec
A little bit of maintenance on the ReasonML examples (#11662)
* Add babel-types package

`next dev` was failing with:

```
Error: Cannot find module 'babel-types'
```

* Upgrade to the latest bs-platform

Also add the `babel-types` package to stop the `next dev` command from complaining.

* Remove extraneous babel-plugin-bucklescript dependency.

Seems the dependency has been deprecated, and it doesn't seem to be required
anyways.
2020-04-06 10:44:01 +02:00
..
bindings New Example: with-reasonml-todo(#7346) 2019-05-23 16:48:13 -05:00
components New Example: with-reasonml-todo(#7346) 2019-05-23 16:48:13 -05:00
pages New Example: with-reasonml-todo(#7346) 2019-05-23 16:48:13 -05:00
.babelrc A little bit of maintenance on the ReasonML examples (#11662) 2020-04-06 10:44:01 +02:00
.gitignore New Example: with-reasonml-todo(#7346) 2019-05-23 16:48:13 -05:00
bsconfig.json New Example: with-reasonml-todo(#7346) 2019-05-23 16:48:13 -05:00
next.config.js upgrade next-transpile-modules to latest everywhere (#10607) 2020-02-20 12:43:55 +01:00
package.json A little bit of maintenance on the ReasonML examples (#11662) 2020-04-06 10:44:01 +02:00
README.md Rename zeit.co/new → zeit.co/import (#10674) 2020-02-24 19:08:34 -05:00

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 ZEIT Now:

Deploy with ZEIT Now

How to use

Using create-next-app

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

npm init next-app --example with-reasonml-todo with-reasonml-app
# or
yarn create next-app --example with-reasonml-todo with-reasonml-app

Download manually

Download the example:

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

Install it and run:

npm install
npm run dev
# or
yarn
yarn dev

Build and run:

npm run build
npm run start
# or
yarn build
yarn start

Deploy it to the cloud with ZEIT Now (Documentation).

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 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.