Morphir

#Morphir

Morphir is a library of tools that works to capture business logic as data.

For the first time, business logic can be shared, stored, translated and visualised, all with the reliability of standardisation ensured in the Morphir framework.

#What is it?

A set of tools for integrating technologies. Morphir is composed of a library of tools that facilitate the digitisation of business logic into multiple different languages & platforms. The Morphir framework is unique too in that facilities elements of automation and conversion that were previously unavailable in the field of finance-tech.

#Why is it important?

Makes business logic portable. Business logic digitised provides distinct advantages: capacity for movement across departments and fields & the ability to be converted to new languages and applications.

#How does it work?

Defines a standard format for storing and sharing business logic. A clear set of standards and format is in-place from the input/output, allowing for coherent structure.

#What are the benefits?

#✔️ Eliminates technical debt risk

Refactoring code libraries is often a harmful and time-sensitive issue for businesses, Morphir ensure the standards introduced from input eliminate delays at deployment.

#✔️ Increases agility

Adaptability and usability are key concepts of the Morphir framework, business logic can now move with the code, be easily understood and adopted, in an ever-developing eco-system.

#✔️ Ensures correctness

Certifying that specified functions behave as intended from input to output is assured through the Morphir library / tool chain.

#✔️ Disseminates information through automation

Morphir’s automated processing helps disseminate information which otherwise may not be understood or shared at all, a useful tool when brining elements of business logic to conversation outside of its immediate audience (i.e developers).

#Documentation

To install the Morphir CLI, see Installing Morphir. For guides, concepts, and reference material, start with the Documentation.

#For Contributors

• Development Guide - Set up your local environment and development workflow
• Contributing Guidelines - Contribution process and governance policies
• Agent Guidelines - Coding standards and best practices

#The Morphir Projects

Morphir consists of a few projects based on the features they provide.

#Core Morphir Projects

• morphir (this project) - The umbrella project
  • Morphir CLI - The canonical morphir command-line tool for working with Morphir IR (in crates/morphir); see the CLI Reference
  • Documentation - Docusaurus-based documentation site (in website/)
  • Ecosystem Integration - Git submodules for ecosystem repos (in ecosystem/); see ecosystem/README.md for details
• morphir-elm - The Elm implementation of Morphir, including:
  • The definition of the IR
  • The Elm compiler for authoring morphir applications in Elm
  • The morphir visualization components and developer tools
  • The Scala, JSON Schema, TypeScript, TypeSpec (Cadl), cypher, semantic, and more backend processors.
  • Note: the morphir-elm npm package also installs an npm-distributed morphir command for Elm workflows. The canonical Morphir CLI is the Rust morphir executable released from this repository.
• morphir-jvm - Supporting SDK and packaging for running morphir on the JVM.
• morphir-examples - A whole lot of examples.

#Incubator Morphir Projects

• morphir-scala - Tight integration with Scala for authoring, execution, and writing tools.
• morphir-bosque - Integration with the Bosque language.
• morphir-dotnet - Integration with .NET via F#.
• morphir-rust - Integration with Rust
• morphir-python - Integration with Python: the IR library and SDK, the Python compiler and the morphir-python extension for the Morphir CLI
• morphir-moonbit - MoonBit implementation of Morphir tooling
• morphir-go - Go implementation of Morphir tooling (CLI, WIT pipeline, Go backends)
• morphir-ui - User-interface work for the Morphir project

Morphir Live has been retired. This repository no longer publishes its web build or release archive. Morphir UI development continues in finos/morphir-ui; no hosted replacement is currently published from this repository.

#Other Resources

List of media

#Further reading

#Roadmap

List the roadmap steps; alternatively link the Confluence Wiki page where the project roadmap is published.

1. Enhanced Scala support
2. Further enhancements for Application modeling with Dapr and Spring Boot.
3. Support for Microsoft's Bosque language for defining models.
4. Modeling queries and aggregations across databases and event processing.

#Getting Involved

#Project Meetings

A great way to interact with the Morphir community is to attend the bi-weekly Thursday Morphir meetings. Email help@finos.org to be added to the meeting invite directly, or find the meeting in the FINOS Community Calendar.

#Contributing

1. Fork it (https://github.com/finos/morphir/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Read our contribution guidelines and Community Code of Conduct
4. Commit your changes (git commit -am 'Add some fooBar')
5. Push to the branch (git push origin feature/fooBar)
6. Create a new Pull Request

NOTE: Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool. Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.

Need an ICLA? Unsure if you are covered under an existing CCLA? Email help@finos.org

#Join the Morphir Slack Channel

Join Morphir on the FINOS Slack by signing up at https://finos-lf.slack.com/. The Morphir channel on Slack is found directly at https://finos-lf.slack.com/messages/morphir/.

Reach out to help@finos.org for any issues when joining Morphir on the FINOS Slack.

#License

Copyright 2022 FINOS

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0

#OpenSpec change proposals

New proposals use the shared html-design workflow, with capability specs, a standalone design.html, and implementation tasks linked to Beads. See the OpenSpec guide for setup and validation.