tilmann-bartsch / marigold

Marigold is a tiny server used to examine and compare the contents of hierarchical structured files.

Marigold

Marigold is a tiny server used to examine and compare the contents of hierarchical structured files.

Installation

• using docker image: Pull docker image from hub.docker.com and run it for the files located in the folder content.

  docker pull tbartsch/marigold
  docker run -it \
      -p 8080:8080 \
      --mount type=bind,source="$(pwd)"/content,target=/marigold/content \
      tbartsch/marigold:latest

• using python venv:

  (cd frontend; yarn build) 
  python -m venv venv
  source venv/bin/activate
  pip install .
  marigold --directory example/marigold

• using nix:

  nix-build nix
  result/bin/marigold --directory example/marigold

Development

• using python venv:

  # Install
  python -m venv venv
  source venv/bin/activate
  pip install -r requirements.txt
  (cd frontend; yarn install)
  # Run
  python marigold/app.py --directory example/marigold --only-backend & \
    (cd frontend; yarn start)

• using nix:

  # Install
  nix-shell nix/shell.nix
  # Run
  python marigold/app.py --directory example/marigold --only-backend & \
    (cd frontend; yarn start)

Nix Packaging Notes

Create yarn.nix-file

cd frontend
nix-shell -p yarn yarn2nix
yarn2nix > yarn.nix

Docker container

Build and run docker image using nix dockerTools.

docker load < $(nix-build nix/docker.nix) || exit
docker run -it \
    -p 8080:8080 \
    --mount type=bind,source="$(pwd)"/example/marigold,target=/content \
    marigold:nightly

Icons

This project uses icons of remixicon project.

Changelog

This library adheres to a semantic versioning scheme. See CHANGELOG.md for the list of changes.

Contributions

Contributions are very welcome! Feel free to report bugs or suggest new features using GitHub issues and/or pull requests.

License

Distributed under MIT License.