Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 1.79 KB

README.md

File metadata and controls

47 lines (34 loc) · 1.79 KB
Raw

Irmin website    OCaml-CI status

This repository contains the source code for irmin.org, which describes the Irmin distributed database and contains tutorials for getting started with Irmin.

Contributing

All contributions are welcome! The tutorial files can be found in data/tutorial.

Building the website locally

The minimum version of Node required to build/run the site is 18. Packages are managed with pnpm. Since we use Node > 16, corepack is the recommended way to manage pnpm. See pnpm's installation instructions for more information.

The website is generated using GatsbyJS. The following commands run an instance of the website locally:

git clone https://github.com/mirage/irmin.org
cd irmin.org

pnpm install # Install build dependencies
pnpm build   # Build the website
pnpm serve   # Serve the build at `localhost:9000`

When working on the website, an incremental development server can be run with pnpm develop, but beware that this may show stale artefacts.

Running tests/linting

  • The source code is formatted with Prettier.
  • Any incorrectly formatted code will be reported by pnpm lint.
  • Use pnpm format to apply the changes.