rsnext/examples/with-reasonml-todo
Luc Leray f52955ec94
Clean up examples package.json (#27121)
Clean up package.json files in the `examples` directory:
- Add `private: true`
- Remove `version` (because they are irrelevant for packages that are not meant to be published)
- Remove `name` (because they are optional for packages that are not meant to be published, and when someone clones an example, they often rename it and the property becomes stale)
- Remove `author`
- Remove `description`
- Remove `license`

Also remove `with-dynamic-app-layout` example completely, since it does the same as `layout-component` (https://github.com/vercel/next.js/pull/27121#discussion_r668178408).

## Documentation / Examples

- [x] Make sure the linting passes
2021-07-12 19:58:03 +00: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 Include all files in Prettier (#17050) 2020-09-14 02:53:19 +00:00
.gitignore Added .gitignore to examples that are deployed to vercel (#15127) 2020-07-16 10:52:23 -04: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 Clean up examples package.json (#27121) 2021-07-12 19:58:03 +00:00
README.md Include utm_source on example links to vercel.com (#21305) 2021-01-19 07:28:54 +00: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 Vercel:

Deploy with Vercel

How to use

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

npx create-next-app --example with-reasonml-todo with-reasonml-app
# or
yarn create next-app --example with-reasonml-todo with-reasonml-app

Deploy it to the cloud with Vercel (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.