Animal Crossing Tune Maker

A website for making Animal Crossing tunes, written in OCaml with Bucklescript-TEA.

Development

• Install dependencies

yarn install

• Run the development server

yarn dev

This will start a dev server on http://localhost:8080 and auto-reload as changes are made.

Note that the SVG files are written manually and it's not recommended to make changes to them via a visual editor, since the code depends on certain classes/elements to exist.

Production

yarn run build

Artifacts will be found in the dist directory on success.

If deploying to GitHub pages, there's also a yarn run deploy script which will build and push to your origin/gh-pages branch (make sure to override the value in static/CNAME if you're using your CNAME).

Editor setup (Optional)

• Install opam (OCaml Package Manager)

  • https://opam.ocaml.org/doc/Install.html

• Install OCaml 4.06.1 (Note: BuckleScript requires 4.06.x)

opam switch create 4.06.1

• Install OCaml-LSP and ocamlformat

opam pin add ocaml-lsp-server https://github.com/ocaml/ocaml-lsp.git
opam install ocaml-lsp-server

opam install ocamlformat

• If you are using VSCode, install OCaml Platform - OCaml Labs; otherwise, use any LSP client.