reservant

Reservant is a utility CLI tool for web development in Haskell. When your Haskell web application is started with reservant, reservant will keep track of the source code of your project, and restart the application once a change is detected.

This project was inspired by Nodemon for Node.js.

Libraries Used

• fsnotify (File watcher)
• rainbow (Colored console output)
• optparse-applicative (CLI)

Installation

Ready Executables

You can download the compiled executables from the latest release page. At this moment, only the executables for Ubuntu and MacOS are available.

Having downloaded the build file, make it executable on the local machine:

$ chmod u+x reservant-ubuntu

Build Locally

First and foremost, clone the repository on your local machine:

$ git clone https://github.com/junkidesu/reservant

To build the tool locally, ensure that the following are installed:

• Stack
• Cabal

Stack and Cabal can be installed either independently or with the GHCup tool.

At the root of the repository, run

$ stack install reservant

To ensure that the tool is installed, run

$ reservant --help

Usage

In the root directory of your Haskell project, run reservant executable, providing the relative path of the module that has the "main" method.

Example:

$ reservant app/Main.hs

Example

To help with local tests of reservant, there is an example minimal Web application. To build and start the example application, perform the following steps:

$ stack build reservant-example 
$ cd reservant-example
$ reservant app/Main.hs

You may find more details here here.

Usage Limitations

At this moment, the file watcher only keeps track of the src directory of the Haskell project.