Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 1.66 KB

README.md

File metadata and controls

61 lines (37 loc) · 1.66 KB
Raw

irmin-web

%%VERSION%%

irmin-web is a tool for building web applications using Irmin. It uses irmin.js to communicate with an irmin-graphql server. The goal for this project is to keep it as generic as possible, allowing users to build whatever they'd like.

irmin-web is distributed under the ISC license.

Homepage: https://github.com/zshipko/irmin-web

Installation

irmin-web can be installed with opam:

opam pin add irmin-web https://github.com/zshipko/irmin-web.git

If you don't use opam consult the opam file for build instructions.

Additionally, there are some browser-based tests for irmin-js. To start the server:

$ make test

Then visit http://localhost:8080 to execute the tests.

Example

See irmin-dashboard.

You can also run irmin-dashboard from the command line using dune:

$ dune exec dashboard/irmin_dashboard.exe" -- --root=/path/to/my/repo

Docker

There is a Dockerfile in the project root that allows you to deploy your irmin-web projects:

$ docker build -f Dockerfile /path/to/my/static/dir

The static file path can also be set using an environment variable:

$ export IRMIN_WEB_ROOT=/path/to/my/static/dir
$ docker build .

Documentation

The documentation and API reference is generated from the source interfaces. It can be consulted online or via odig doc irmin-web.