Skip to content

Latest commit

 

History

History
77 lines (51 loc) · 3.03 KB

README.md

File metadata and controls

77 lines (51 loc) · 3.03 KB
Raw

Crayfish

Crayfish Commons

Minimum PHP Version Build Status Contribution Guidelines LICENSE codecov

Introduction

Crayfish Commons is a library housing shared code for Crayfish microservices. Shared Classes include:

  • ApixMiddleware
  • CmdExecuteService

Requirements

Installation

Crayfish-commons can be installed with composer like composer require islandora/crayfish-commons

Configuration

To configure this bundle in your Symfony application, add a file in the config/packages or config/packages/(prod|dev|test) folder called crayfish_commons.yaml. The contents of this file will be

crayfish_commons:
  fedora_base_uri: 'http://your-fedora-base-uri'
  apix_middleware_enabled: true

Documentation

Further documentation for this module is available on the Islandora documentation site.

Troubleshooting/Issues

Having problems or solved a problem? Check out the Islandora google groups for a solution.

Maintainers

This project has been sponsored by:

  • UPEI
  • discoverygarden inc.
  • LYRASIS
  • McMaster University
  • University of Limerick
  • York University
  • University of Manitoba
  • Simon Fraser University
  • PALS
  • American Philosophical Society
  • common media inc.

Development

If you would like to contribute, please get involved by attending our weekly Tech Call. We love to hear from you!

If you would like to contribute code to the project, you need to be covered by an Islandora Foundation Contributor License Agreement or Corporate Contributor License Agreement. Please see the Contributors pages on Islandora.ca for more information.

We recommend using the islandora-playbook to get started. If you want to pull down the submodules for development, don't forget to run git submodule update --init --recursive after cloning.

License

MIT