steedos-overview
Steedos Platform Overview | Steedos 平台概览
What is Steedos? | 什么是 Steedos?
Steedos (华炎魔方) is an enterprise low-code platform for building business applications. Developers define data models, UI, permissions, and business logic through YAML metadata files, and the platform generates a full-stack application with REST API, real-time WebSocket, and a React + Amis frontend.
Steedos（华炎魔方）是一个企业级低代码平台。开发者通过 YAML 元数据文件定义数据模型、UI、权限和业务逻辑，平台自动生成包含 REST API、实时 WebSocket 和 React + Amis 前端的全栈应用。
Technology Stack | 技术栈
- Runtime: Node.js + TypeScript
- Backend: NestJS 11 + Moleculer 0.14 microservices
- Frontend: React + Amis (Baidu low-code UI framework)
- Database: MongoDB / PostgreSQL / MySQL
- Metadata: YAML files (.object.yml, .button.yml, .trigger.yml, etc.)
- NOT Python — all server-side code is JavaScript/TypeScript
Core Concepts | 核心概念
- Objects — Database tables defined in YAML (.object.yml), with fields, relationships, and standard audit columns
- Metadata Files — YAML files that declare UI, logic, and security; deployed via CLI or file sync
- Packages — Self-contained modules (steedos-packages/*) that bundle objects, triggers, pages, and permissions
- Triggers — Server-side JavaScript hooks that run before/after data operations (insert, update, delete)
- Functions — Server-side JavaScript functions exposed as REST API endpoints
- Micro Pages — Custom UI pages built with the Amis JSON schema framework
- Builder6 Server — The NestJS-based runtime that serves the REST API, WebSocket, and plugin system
Skill Routing | 技能路由
By Task | 按任务选择技能
"I want to create a new project" → steedos-project-format → steedos-package-format → steedos-environment-variables
"I want to understand built-in objects" → steedos-builtin-objects (core objects: users, spaces, organizations, permission_set, apps, accounts, contacts, tasks, etc.)
"I want to define data models and fields" → steedos-objects → steedos-object-fields → steedos-object-list-views
"I want to add business logic" → steedos-object-triggers (event hooks) → steedos-object-functions (REST-exposed functions) → steedos-object-buttons (UI actions)
"I want to build UI pages" → steedos-micro-pages (standalone pages) → steedos-object-micro-pages (object detail/form pages) → steedos-applications + steedos-tabs (navigation)
"I want to develop custom React amis components" → steedos-webapps (React + Vite webapps in packages with IIFE amis Renderer registration)
"I want to set up permissions and i18n" → steedos-object-permissions → steedos-translations
"I want to create dashboards and reports" → steedos-dashboards → steedos-questions (requires enterprise license)
"I want to load seed data" → steedos-seed-data
"I want to use the CLI" → steedos-cli-commands (start, deploy, import/export)
"I want to use the REST or GraphQL API" → steedos-server-api (REST) → steedos-graphql-api (GraphQL)
"I want to understand the server" → steedos-server-architecture → steedos-server-api → steedos-graphql-api → steedos-server-config → steedos-server-moleculer → steedos-server-websocket
"I want to work with Builder6 internals" → steedos-builder6-architecture → steedos-builder6-api → steedos-builder6-config → steedos-builder6-tables → steedos-auth → steedos-files → steedos-plugin
Typical Development Flow | 典型开发流程
1. steedos-project-format → Create project structure
2. steedos-objects → Define data models
3. steedos-object-fields → Add fields and relationships
4. steedos-object-triggers → Add validation and automation
5. steedos-object-buttons → Add custom actions
6. steedos-object-list-views → Configure list displays
7. steedos-applications → Create app with navigation
8. steedos-tabs → Define tabs for the app
9. steedos-object-permissions → Set up access control
10. steedos-translations → Add i18n labels
11. steedos-cli-commands → Deploy and manage
All Skills | 全部技能一览
| Category | Skills |
|---|---|
| Foundation | steedos-project-format, steedos-package-format, steedos-environment-variables, steedos-cli-commands |
| Data Modeling | steedos-builtin-objects, steedos-objects, steedos-object-fields, steedos-object-list-views |
| Business Logic | steedos-object-triggers, steedos-object-functions, steedos-object-buttons, steedos-object-micro-pages |
| UI & Apps | steedos-applications, steedos-tabs, steedos-micro-pages, steedos-webapps |
| Analytics | steedos-dashboards, steedos-questions |
| Security | steedos-object-permissions |
| i18n | steedos-translations |
| Data | steedos-seed-data |
| Server | steedos-server-architecture, steedos-server-api, steedos-graphql-api, steedos-server-config, steedos-server-moleculer, steedos-server-websocket |
| Builder6 | steedos-builder6-architecture, steedos-builder6-api, steedos-builder6-config, steedos-builder6-tables, steedos-auth, steedos-files, steedos-plugin |
Key File Types | 关键文件类型
| Extension | Purpose | Skill |
|---|---|---|
.object.yml |
Object definition | steedos-objects |
.field.yml |
Field definition | steedos-object-fields |
.trigger.yml |
Server trigger | steedos-object-triggers |
.function.yml |
Server function | steedos-object-functions |
.button.yml |
Custom button | steedos-object-buttons |
.listview.yml |
List view | steedos-object-list-views |
.app.yml |
Application | steedos-applications |
.tab.yml |
Navigation tab | steedos-tabs |
.page.yml + .page.amis.json |
Micro page | steedos-micro-pages |
.permission.yml |
Permission set | steedos-object-permissions |
.translation.yml |
Translation | steedos-translations |
.data.yml / .data.json |
Seed data | steedos-seed-data |
Install | 安装
npx skills add steedos/steedos-platform --all
npx skills add steedos/steedos-platform --skill steedos-overview