package vif
Build not checkedInstall
dune-project
Dependency
Authors
Maintainers
Sources
sha256=a16ff3dba7675d237d59188b032052b383ad9e367eb7c570c4e6e78b978b98e5
sha512=ad553f15f33f9f2427b691713f630476fd1f15b4cb61944a401cfb35c29dd3d1d3760b02dd211bddd39b6cf6ccc8ea5d9f88eefc3776611e2a7020242a16b9a9
Description
Added to opam-repository:
README
νιϝ, a small framework for building a web server from an OCaml script
(nu)(iota)(digamma)
disclaimer: Please note that this is an experimental project. It's also an opportunity to build something that can be satisfying for web development. However, we do not recommend using this project in production.
Vif is a small program that runs an OCaml script and launches a Web server from it. The main idea is to be able to set up a typed Web server as quickly as possible (note that we use hurl, an HTTP client in OCaml)
$ opam pin add -y https://github.com/robur-coop/vif
$ opam pin add -y https://github.com/robur-coop/hurl
$ opam install vif hurl
$ cat >main.ml <<EOF
#require "vif" ;;
let default req server () =
let field = "content-type" in
let open Vif.Response.Syntax in
let* () = Vif.Response.add ~field "text/html; charset=utf-8" in
let* () = Vif.Response.with_string req "Hello World!" in
Vif.Response.respond `OK
;;
let routes =
let open Vif.Uri in
let open Vif.Route in
[ get (rel /?? nil) --> default ]
let () =
Miou_unix.run @@ fun () ->
Vif.run routes ()
;;
EOF
$ vif --pid vif.pid main.ml &
$ hurl http://localhost:8080/
HTTP/1.1 200 OK
connection: close
content-length: 12
content-type: text/html
Hello World!
$ kill -SIGINT $(cat vid.pid)Examples
The examples folder contains several examples of the use of vif. It shows the management of more complex requests (json, multipart-form, etc.) as well as the use of an SQL database with caqti. A complete example of a web application that uses dune is available here. It is a summary of our tutorial available here: creating a user space with a chatroom using Vif.
Dependencies (21)
-
tyxml
>= "4.6.0" - hmap
- multipart_form-miou
- conan-database
-
conan-unix
>= "0.0.6" -
decompress
>= "1.5.0" - mirage-crypto-rng-miou-unix
-
tyre
>= "1.0" -
httpcats
>= "0.2.0" & < "0.3.0" -
cmdliner
>= "1.3.0" -
jsont
>= "0.2.0" -
fluxt
>= "0.0.1~beta2" -
flux
>= "0.0.1~beta2" - bytesrw
-
fpath
>= "0.7.3" -
logs
>= "0.9.0" -
bos
>= "0.2.1" & < "0.3.0" -
fmt
>= "0.11.0" -
uri
>= "4.4.0" -
dune
>= "3.0.0" -
ocaml
>= "5.3.0"
Dev Dependencies (5)
-
brr
with-test -
caqti-driver-sqlite3
with-test -
caqti-miou
with-test -
jwto
with-test -
hurl
with-test
Optional Dependencies
None
Used by (1)
-
vifu
< "0.0.1~beta3"
Conflicts (1)
-
result
< "1.5"
Build status
Results of building vif with each compiler on check.ci.ocaml.org, run of against opam-repository 78c202b. All results for this package.
Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.
This version is not in the latest run; the versions below are.
- good Package successfully built
- partial One of the dependencies failed to build
- bad Package failed to build
- n/a Package is not available in this environment
- internal Internal failure