Skip to content

Template for building a revery app

License

Notifications You must be signed in to change notification settings

HakKet/template-revery-app

 
 

Repository files navigation

hello_world

This is a Revery app.

Template Init

There are two convenience scripts to initialize this repo:

  • scripts/rename hello_world my_library
    • This updates appropriate filenames and contents to use "my_library" as the name.
    • Arguments should be snake_case, they will be converted to other forms where appropriate.
  • scripts/vscode
    • This sets up editor support for the OCaml Platform extension by creating .vscode/settings.json.
    • This can be done manually or inside VS Code, but I find this easier.

Remove this section from the readme after completing the initialization.

Install esy

Globally install esy so that the esy command is available in the terminal.

npm install -g esy

This may be useful: Global npm without sudo

Install the dependencies and build

esy
esy @app
esy @test

This is a combination of esy install and esy build

Launch app

esy app

This should automatically rebuild if there are changes

Run tests

esy test

This should automatically rebuild if there are changes

More Details

  • For more details and additional setup see: details.md
    • Editor support
    • Adding dependencies
    • Recursive dub-directories
    • Ignoring warnings
    • Printing stack traces

Next Steps

For CI/CD, check out esy-ocaml/hello-reason.

About

Template for building a revery app

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 52.8%
  • Reason 45.6%
  • C++ 1.6%