Skip to content

module.rk ​

A reusable business unit (modules/<name>/module.rk): models, rules, flows and roles. It requires other modules; menus, dashboards, home and onboarding belong to an app.

Lives in modules/<module>/module.rk · Schema module.json (source) · first line: # yaml-language-server: $schema=https://rangka-os.github.io/rangka-os/schema/0.5/module.json

Properties ​

PropertyTypeMeaning
name requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
version requiredstring
pattern ^\d+\.\d+\.\d+$
title requiredlabelA label in Bahasa Indonesia (required) and optionally English.
title.id requiredstring
title.enstring
summarylabelOne sentence in plain words for the catalogue (contract 0036)
summary.id requiredstring
summary.enstring
categorysales · purchasing · stock · finance · tax · people · operations · messaging · payments · marketplace · otherCatalogue group (contract 0036)
iconstringA Remix icon name from the design system, e.g. store-2-line (contract 0036)
pattern ^[a-z0-9]+(-[a-z0-9]+)*$
requiresmap of stringmodule → version range (^1.0, >=1.2); rangka: '>=0.5' pins the kernel
optionalmap of string
hookslist of string

Example ​

From rangka-apps/modules/pipeline/module.rk (first 60 lines):

yaml
# yaml-language-server: $schema=https://rangka-os.github.io/rangka-os/schema/0.5/module.json
name: pipeline
version: 1.0.0
title: {id: Pipeline penjualan, en: Sales pipeline}
summary:
  id: Lead, peluang dan aktivitas penjualan sampai closing.
  en: Leads, deals and sales activities through to closing.
category: sales
icon: funnel-line
requires: {rangka: '>=0.5', contacts: ^1.0, users: ^1.0}
optional: {invoicing: ^1.0}
hooks: [crm.convert_lead, crm.mark_won]

Generated from the schema by website/scripts/gen-reference.mjs. Edit the schema, not this page.

Rangka OS is source-available under the Elastic License 2.0 (ELv2). Free to self-host.