You need Esy, you can install the latest version from npm:

yarn global add esy@latest
# Or
npm install -g esy@latest

NOTE: Make sure esy --version returns at least 0.5.8 for this project to build.

Then run the esy command from this project root to install and build depenencies.

esy

Now you can run your editor within the environment (which also includes merlin):

esy $EDITOR
esy vim

Alternatively you can try vim-reasonml which loads esy project environments automatically.

After you make some changes to source code, you can re-run project's build again with the same simple esy command.

esy

This project uses Dune as a build system, if you add a dependency in your package.json file, don't forget to add it to your dune and dune-project files too.

After building the project, you can run the main binary that is produced.

esy start

You can test compiled executable (runs scripts.tests specified in package.json):

esy test

Documentation for the libraries in the project can be generated with:

esy doc
open-cli $(esy doc-path)

This assumes you have a command like open-cli installed on your system.

NOTE: On macOS, you can use the system command open, for instance open $(esy doc-path)

esy allows creating prebuilt binary packages for your current platform, with no dependencies:

esy release

This creates a directory _release containing a ready-to-publish npm package. You can go to this directory and execute npm publish:

cd _release
npm publish

The following snippet describes Dune Rely Demo's repository structure.

.
├── bin/
|   Source for dune-rely-demo's binary. This links to the library defined in `lib/`.
│
├── lib/
|   Source for Dune Rely Demo's library. Contains Dune Rely Demo's core functionnalities.
│
├── test/
|   Unit tests and integration tests for Dune Rely Demo.
│
├── test_runner/
|   Source for the test runner's binary.
│
├── dune-project
|   Dune file used to mark the root of the project and define project-wide parameters.
|   For the documentation of the syntax, see https://dune.readthedocs.io/en/stable/dune-files.html#dune-project
│
├── LICENSE
│
├── package.json
|   Esy package definition.
|   To know more about creating Esy packages, see https://esy.sh/docs/en/configuration.html.
│
├── README.md
│
└── dune-rely-demo.opam
    Opam package definition.
    To know more about creating and publishing opam packages, see https://opam.ocaml.org/doc/Packaging.html.