Skip to content

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 ​

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
labellabelA label in Bahasa Indonesia (required) and optionally English.
label.id requiredstring
label.enstring
summarylabelA label in Bahasa Indonesia (required) and optionally English.
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]+)*$
rangkastringkernel version range, e.g. '>=0.5'
modules requiredmap of stringmodule → version range (^1.0, >=1.2): the modules this app installs
optionalmap of string
recommendsmap of string
connectorslist of object
connectors[].name requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
connectors[].flowstring
connectors[].requiredboolean
fixtureslist of string
roleslist of name
hookslist of string
menulist of object
menu[].group requiredlabelA label in Bahasa Indonesia (required) and optionally English.
menu[].group.id requiredstring
menu[].group.enstring
menu[].items requiredlist of name or object
menu[].collapsedbooleanStarting state of the group before the person folds or opens it (contract 0037); the site layout's nav.side wins
dashboardslist of nameDashboards in dashboards/*.rk, in menu order. The first is the app's home page.
homeobject
home.modelnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
home.viewlist · kanban · calendar · report
home.dashboardnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
worklist of objectWork 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 requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
work[].roleslist of nameNarrows the screen's own roles (default: all of them)
at least 1
work[].homeboolean
onboardinglist of object
onboarding[].ask requiredlabelA label in Bahasa Indonesia (required) and optionally English.
onboarding[].ask.id requiredstring
onboarding[].ask.enstring
onboarding[].optionslist of string
onboarding[].sets requiredstring

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_business

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.