Overview

Nalubale Frontend

React frontend for the Nalubale Holdings Company Ltd shareholder management system

Get Started

Contribute

Conventions

Guidance

Interpret the key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL as described in RFC 2119.

Authoritative guidance using these key words appear in admonitions titled “Guidance”, like above. An explanation of the rationale for the rule plus supporting material appears after in separate paragraphs, like this. Usually, each rule falls under its own subheading, which facilitates cross-referencing. Top-level headings provide a content summary or a quick reference.

Scope

This documentation covers the Nalubale frontend: how to set it up, and contribute to it. The backend API is documented in the nalubale-backend project.

Audience

Developers working on the frontend.

Authoring

This document is written using MyST Markdown, a strict superset of the CommonMark syntax specification that adds features focused on scientific and technical documentation authoring. Markdown is specifically designed to be readable across multiple devices in a variety of formats without requiring an online Internet connection. Formatting, collaborative editing, and publishing follows the same standards and practices described herein.

Structure