Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 2.27 KB

README.md

File metadata and controls

43 lines (31 loc) · 2.27 KB

Chronicle Bootstrap

This repo serves as a base for setting up your own Chronicle domain.

It contains the structure and Makefile which can be used to build docker images and run a local instance of Chronicle.

It does not contain an example domain, however if you would like to test it, you can use a domain from the Chronicle Examples repo.

For example, the manufacturing domain.

Chronicle Documentation

Documentation for Chronicle in general may be found here. Example domains may be found here.

Setting up your own domain

This repository follows the same structure as the Chronicle Examples repository, which you can use for reference.

To get started with Chronicle Bootstrap:

  1. Clone this repo, or download it as a zip file from GitHub here. Please note, if you download or copy the repo rather than cloning it, you will need to make sure you keep it up to date with the latest Chronicle releases in the future.
  2. Add your domain.yaml file in its own directory inside the domains directory. The name of its directory should be the name of your domain. For example, if your domain is called manufacturing, you would create domains/manufacturing/domain.yaml.

From there, we suggest using the following sections of the Chronicle Examples README as a guide: