app.rk
What a customer installs (apps/<name>/app.rk): the modules it uses, connectors, roles, menu, dashboards, home and onboarding. An app defines no models; make a module instead.
Lives in apps/<app>/app.rk · Schema app.json (source) · first line: # yaml-language-server: $schema=https://rangka-os.github.io/rangka-os/schema/0.5/app.json
Properties
| Property | Type | Meaning |
|---|---|---|
name required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
version required | string | pattern ^\d+\.\d+\.\d+$ |
title required | label | A label in Bahasa Indonesia (required) and optionally English. |
title.id required | string | |
title.en | string | |
label | label | A label in Bahasa Indonesia (required) and optionally English. |
label.id required | string | |
label.en | string | |
summary | label | A label in Bahasa Indonesia (required) and optionally English. |
summary.id required | string | |
summary.en | string | |
category | sales · purchasing · stock · finance · tax · people · operations · messaging · payments · marketplace · other | Catalogue group (contract 0036) |
icon | string | A Remix icon name from the design system, e.g. store-2-line (contract 0036) pattern ^[a-z0-9]+(-[a-z0-9]+)*$ |
rangka | string | kernel version range, e.g. '>=0.5' |
modules required | map of string | module → version range (^1.0, >=1.2): the modules this app installs |
optional | map of string | |
recommends | map of string | |
connectors | list of object | |
connectors[].name required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
connectors[].flow | string | |
connectors[].required | boolean | |
fixtures | list of string | |
roles | list of name | |
hooks | list of string | |
menu | list of object | |
menu[].group required | label | A label in Bahasa Indonesia (required) and optionally English. |
menu[].group.id required | string | |
menu[].group.en | string | |
menu[].items required | list of name or object | |
menu[].collapsed | boolean | Starting state of the group before the person folds or opens it (contract 0037); the site layout's nav.side wins |
dashboards | list of name | Dashboards in dashboards/*.rk, in menu order. The first is the app's home page. |
home | object | |
home.model | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
home.view | list · kanban · calendar · report | |
home.dashboard | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
work | list of object | Work screens of the app's modules bound to roles (contract 0030 §3). A screen not named here is not offered; home: true makes it the landing page of those roles. |
work[].screen required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
work[].roles | list of name | Narrows the screen's own roles (default: all of them) at least 1 |
work[].home | boolean | |
onboarding | list of object | |
onboarding[].ask required | label | A label in Bahasa Indonesia (required) and optionally English. |
onboarding[].ask.id required | string | |
onboarding[].ask.en | string | |
onboarding[].options | list of string | |
onboarding[].sets required | string |
Example
From rangka-apps/apps/crm/app.rk (first 60 lines):
yaml
# yaml-language-server: $schema=https://rangka-os.github.io/rangka-os/schema/0.5/app.json
name: crm
version: 1.0.0
title: {id: CRM, en: CRM}
label: {id: Rangka CRM, en: Rangka CRM}
rangka: '>=0.5'
modules: {contacts: ^1.0, catalogue: ^1.0, pipeline: ^1.0, invoicing: ^1.0, outlets: ^1.0, users: ^1.0}
dashboards: [crm_overview, sales_overview]
menu:
- group: {id: CRM}
items: [deal, lead, activity]
- group: {id: Penjualan}
items: [sales_invoice]
- group: {id: Data induk}
items: [customer, item, outlet, user]
summary:
id: Kelola lead dari WhatsApp sampai closing, dengan pipeline yang bisa langsung jadi faktur.
category: sales
icon: customer-service-2-line
connectors:
- name: whatsapp_business
flow: pipeline/flows/whatsapp_to_lead.rk
required: false
fixtures: []
roles: [sales_rep, sales_manager]
home: {model: deal, view: kanban}
onboarding:
- ask: {id: 'Berapa orang tim sales kamu?'}
sets: seed.users
- ask: {id: 'Dari mana pelanggan biasanya datang?'}
options:
- whatsapp
- instagram
- referral
- walk_in
- website
- marketplace
sets: lead.source.options
- ask:
id: Tahap jualan kamu sama dengan Prospek → Kualifikasi → Penawaran → Negosiasi → Menang/Kalah?
sets: deal.stage.options
- ask:
id: Sambungkan WhatsApp Business supaya chat masuk otomatis jadi lead?
sets: connectors.whatsapp_businessGenerated from the schema by website/scripts/gen-reference.mjs. Edit the schema, not this page.