Skip to content

ManasJayanth/melange-esy-template

 
 

Repository files navigation

melange-esy-template

A simple project template using Melange with esy.

If you are looking for a template with opam, check melange-opam-template.

Quick Start

npm install

# In separate terminals:
npm run build:watch
npm run serve

React

React support is provided by reason/react. The entry point of the sample React app is src/ReactApp.re.

Commands

  • npm install - installs the npm/JavaScript dependencies, including the esy package manager (see below)
  • npm run build:watch - uses esy to:
    • Install OCaml-based dependencies (e.g. OCaml and Melange)
    • Symlink Melange's JavaScript runtime into node_modules/melange, so that JavaScript bundlers like Webpack can find the files when they're imported
    • Compile the project's ReasonML/OCaml/ReScript source files to JavaScript
    • Rebuild files when changed (via Melange's built-in watch mode)
  • npm run serve - starts a dev server to serve the frontend app

JavaScript output

Since Melange just compiles source files into JavaScript files, it can be used for projects on any JavaScript platform - not just the browser.

All ReasonML/OCaml/ReScript source files under src/ will be compiled to JavaScript and written to _build/default/src/* (along with some other build artifacts).

For example, src/Hello.ml (using OCaml syntax) and src/Main.re (using ReasonML syntax) can each be run with node:

node _build/default/src/node/src/Hello.js
node _build/default/src/node/src/Main.js

About

A simple project template using Melange

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published

Languages

  • Reason 45.8%
  • JavaScript 31.6%
  • HTML 17.9%
  • OCaml 4.7%