Skip to content

Start here — navigate OpenPlatform

This hub documents OpenPlatform as the module platform in firefly-oss: what each module is for, how exp-* / domain-* / core-* compose, which repositories exist, and where OpenAPI and adapters live.

It does not teach how to scaffold or build Java services on the framework train. For framework tooling and service bootstrap, use the Jafly docs.

The story in four stops

  1. Ecosystem

    OpenPlatform equals firefly-oss modules and libraries. Framework details stay outbound.

  2. Architecture

    How experience, domain, and core bands fit, and where adapters sit.

  3. Module catalogue

    Every business module id with repository maps and OpenAPI links grounded in real repos.

  4. Integrate and OpenAPI index

    firefly-oss libraries (library-psps, library-rails) and published contracts.

How to pick a module page

  1. Match the journey step (party, product, payment, loan, and so on) to a module id on the catalogue.
  2. Open that module page for purpose, when-to-use, layer map, and OpenAPI links.
  3. Follow repository READMEs for local run details; this hub does not duplicate them.
  4. Put anything outside Firefly behind the adapter pattern.

Layer prefixes (quick map)

Prefix Role in firefly-oss
exp-* Experience / BFF journeys for channels
domain-* Domain orchestration (commands, queries, processes)
core-* Persistence and core APIs for a bounded context
library-* Shared ports (for example library-psps, library-rails)

Version pin (brief)

OpenPlatform modules currently consume framework train 26.10.19 (Spring Boot 4.1.1, Java 25) through com.firefly:firefly-parent. Details and publish notes: Versioning and BOM. Framework how-to: Jafly docs.

Next