Repositories
Fortuna lives in two code repositories, the API and the UI, and this
documentation site has a repository of its own. Both code repositories keep
their context documents in docs/initial/ and their normative specification in
docs/requirements/, and both track their work on GitHub project boards and
milestones.
The repositories
| Repository | What it holds | Default branch | Latest release |
|---|---|---|---|
| fortuna-api | The API, built with ASP.NET Core on .NET 10, and the native core in Rust (native/), with the committed OpenAPI document, the specification documents and the tests. | develop | v2.1.0 |
| fortuna-ui | The Flutter application for the web, Windows, Linux and Android that reads and writes through the API, with its specification documents. | develop | v1.0.0 |
| fortuna-docs | This site: documentation only, no software and no package. | main, the branch its Pages workflow publishes from | None |
Both code repositories mark those releases Latest on GitHub. The API’s
earlier release is
v2.0.0, and
v1.0.0 of the API has a tag but no GitHub release. Each repository’s releases
page (API,
UI) lists every version,
and each repository’s CHANGELOG.md is the curated record of what changed:
API,
UI.
The releases of both code repositories have no attached files, and no installer or package exists yet. What you can build or take from CI instead is in Getting a release.
The documentation of each code repository is on its default branch, develop,
and the links below use it. Related projects are
Heimdall, the identity provider
Fortuna signs in through (its repositories are
heimdall-api and
heimdall-ui), and
yggdrasil, the deployment platform
described under Operations.
fortuna-api
The API’s specification is 12 documents: five in
docs/initial/
and seven in
docs/requirements/.
The API’s OpenAPI document,
docs/openapi/fortuna.json,
is generated from the code and committed; the
API reference page maps it, and the
explorer renders it. The native core
has its own
README.
Initial documents
Context and the first form of the rules, written before the formal set.
| Document | What it is |
|---|---|
| Brainstorm | The original free-form notes the project grew from. |
| Project Overview | What the project is, who it is for, and how success is measured. |
| Technology Stack | The informal stack decisions. The exact versions are pinned once, in the Technology Stack Document. |
| Workflow | How one use case is delivered, step by step: the operational form of the Development Workflow Document. |
| Business Rules | The domain entities, their relationships and the BR-01 to BR-46 rules. This site cites them as API-BR-xx. |
Requirements documents
The normative specification.
| Document | What it is |
|---|---|
| Vision Document | Why the API exists, who it serves, its stakeholders, and the F-01 to F-20 features. |
| System Requirements Document | The FR-<AREA>-xx and NFR-xx requirements, the data model, the endpoint surface, the authorization matrix and the traceability. |
| Use Case Specification Document | The application use cases, their flows and their AF-xx alternatives. |
| Technology Stack Document | The single source of truth for every technology and its version. |
| Operations & Infrastructure Document | Layout, configuration, logging, health, UC-75, and the IR-01 to IR-27 platform requirements. |
| Testing Specification Document | How tests are written, named and run. |
| Development Workflow Document | The normative branch pattern, issue lifecycle, approval gates and Definition of Done. |
fortuna-ui
The UI’s specification is also 12 documents: five in
docs/initial/
and seven in
docs/requirements/.
The UI has no documentation site of its own, so these pages on GitHub are the
source. The User guide on this site draws
on them.
Initial documents
| Document | What it is |
|---|---|
| Brainstorm | The original free-form notes the project grew from. |
| Project Overview | What the project is, who it is for, and how success is measured. |
| Technology Stack | The informal stack decisions. The exact versions are pinned once, in the Technology Stack Document. |
| Workflow | How one use case is delivered, step by step: the operational form of the Development Workflow Document. |
| Business Rules | What the client owns, and the BR-xx rules. This site cites them as UI-BR-xx. |
Requirements documents
| Document | What it is |
|---|---|
| Vision Document | Why the UI exists, who it serves, its stakeholders, and the F-xx features. |
| System Requirements Document | The FR-<AREA>-xx and NFR-xx requirements, the data model, the screen surface and the traceability. |
| Use Case Specification Document | The UC-xx use cases, their flows and their AF-xx alternatives. |
| Technology Stack Document | The single source of truth for every technology and its version. |
| Operations & Infrastructure Document | Layout, configuration, the generation pipelines, CI, packaging, and the IR-01 to IR-22 platform requirements. |
| Testing Specification Document | How tests are written, named and run. |
| Development Workflow Document | The normative branch pattern, issue lifecycle, approval gates and Definition of Done. |
Project boards and milestones
Work on both code repositories is tracked on public GitHub project boards, which are the live view of what is done and what is in progress, and in milestones grouped by theme.
| Repository | Project board | Milestones |
|---|---|---|
| fortuna-api | Fortuna API | Milestones: M-01 Foundation, M-02 Access and cross-cutting mechanisms, M-03 Holdings, M-04 Money movement, M-05 Organization and planning, M-06 Ingestion, and M-07 Insight and output |
| fortuna-ui | Fortuna UI | Milestones: M-01 Foundation, M-02 Access, shell and privacy, M-03 Holdings, M-04 Money movement and lifecycle, M-05 Organization and planning, M-06 Ingestion and attachments, and M-07 Insight and output |
The board and the milestone pages show the current state. The READMEs of the repositories carry their own status lines and counts, but GitHub is the source of truth, so this site does not repeat progress counts that would go stale. What the interface does not cover yet is under Status on the Overview page.
Each issue moves from Todo through In Progress and Testing to Done, and each use case ships on its own branch, issue and pull request, as the Development Workflow Documents describe. The process is on the Development page.