https://github.com/melange-re/melange-esy-template

A simple project template using Melange
https://github.com/melange-re/melange-esy-template

Last synced: 27 days ago
JSON representation

A simple project template using Melange

• Host: GitHub
• URL: https://github.com/melange-re/melange-esy-template
• Owner: melange-re
• License: mit
• Created: 2021-04-02T17:03:24.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-21T01:20:46.000Z (11 months ago)
• Last Synced: 2024-08-03T16:09:52.520Z (4 months ago)
• Language: Reason
• Size: 223 KB
• Stars: 42
• Watchers: 5
• Forks: 16
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# melange-esy-template

A simple project template using [Melange](https://github.com/melange-re/melange)

with [esy](https://esy.sh/).

If you are looking for a template with opam, check [melange-opam-template](https://github.com/melange-re/melange-opam-template).

## Quick Start

```shell

npm install

# In separate terminals:

npm run build:watch

npm run serve

```

### React

React support is provided by

[`reason/react`](https://github.com/reasonml/reason-react/). The entry

point of the sample React app is [`src/ReactApp.re`](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`](src/Hello.ml) (using OCaml syntax) and

[`src/Main.re`](src/Main.re) (using ReasonML syntax) can each be run with

`node`:

```bash

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

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

```