Getting started with DMARCaroni
This document is for people who are unfamiliar with command line tools.
Step I: Install the Haskell server
Option 1: Executable
Download the repo only containing the config file and executable here
Option 2: Compile from source files
Download the repo containing the all the source files here
Then install The Haskell Tool Stack here or (when using Nix) type:
$ nix-shell
Once stack is installed we can run all the implemented tests:
$ stack test
When all the tests get completed succesfully, we want to install the executable:
$ stack install
Step II: Run the Haskell server
If you want to run the server, type:
$ DMARCaroni-server
Make sure your config.dhall file is configured correctly, you can always take a look here to find the standard settings
To get a list with all the supported options, you can always do:
$ DMARCaroni-server --help
Step III: Install the Elm client
Option 1:
Download the repo only containing the assets, html and javascript here
Option 2: Compile from source files
Download the repo containing all the client source files here
Then install Elm here or (when using Nix) type:
$ nix-shell
After you have installed Elm, to compile the client, type:
elm make src/Main.elm --output="dist/main.js"
If you want to host your web-app locally on your machine (standard on port 8000), type:
elm reactor
And if you want to start developing, you might want to take a look into elm-watch to recompile whenever your Elm files change and reload the compiled JS in the browser.