example

Demo

A short, but powerful statement about your project

Set up your development environment

You need opam. You can install it by following opam's documentation.

With opam installed, you can install the dependencies in a new local switch with:

make switch

Or globally, with:

make deps

Then, build the project with:

make build

Running the server

After building the project, you can run the server with:

make start

To start the server in watch mode, you can run:

make watch

This will restart the server on filesystem changes and reload the pages automatically.

Running tests

You can run the unit test suite with:

make test

Building documentation

Documentation for the libraries in the project can be generated with:

make doc

To serve the documentation:

make servedoc

Repository structure

The following snippet describes Demo's repository structure.

.
├── bin/
|   Source for demo's binary. This links to the library defined in `lib/`.
│
├── lib/
|   Source for Demo's library. Contains Demo's core functionalities.
│
├── test/
|   Unit tests and integration tests for Demo.
│
├── dune-project
|   Dune file used to mark the root of the project and define project-wide parameters.
|   For the documentation of the syntax, see https://dune.readthedocs.io/en/stable/dune-files.html#dune-project.
│
├── LICENSE
│
├── Makefile
|   `Makefile` containing common development commands.
│
├── README.md
│
└── demo.opam
    opam package definition.
    To know more about creating and publishing opam packages, see https://opam.ocaml.org/doc/Packaging.html.