Tachybase Documentation
website·Indexed 31 days ago
https://tachybase.orgDeveloper documentation for Tachybase, covering installation via Git, server-side development (middleware, collections, events, and i18n), client-side UI schema rendering, and advanced workflow configuration including event sources and process control.
What's inside Tachybase
- The Table card is a core built-in data block in Tachybase used to display and manage structured data. It allows developers to customize table columns, column widths, sorting rules, and data scopes. It also supports built-in operations such as filtering, creating, copying, editing, and deleting records.
Overview of Modals in Tachybase
Modals are small windows used to display extended content (such as order or product details) or to edit data without leaving the current page. They are critical for card operations like adding, viewing, and editing data. Tachybase supports two primary modal types: Drawers and Dialogs.Overview of Tachybase Low-Code Platform
Tachybase is a low-code development platform built on TypeScript and Node.js designed for rapid application construction. It emphasizes flexibility, openness, and loose coupling, allowing developers to use the frontend renderer, a visual editor, or focus on backend development. The platform is cloud-agnostic and can be deployed to any environment using traditional database technologies without intermediate layers.Overview of Tachybase Access Control (ACL)
Tachybase's ACL module is split into two components: the core functionality provided by@tachybase/acland the dynamic configuration capabilities provided by the@tachybase/plugin-aclplugin. The ACL plugin is built-in and does not require separate installation.Overview of tachybase Workflow plugin
The Workflow plugin is a Business Process Management (BPM) tool designed for no-code scenarios in tachybase. It allows developers to orchestrate and configure automated business processes using a combination of a trigger and multiple execution nodes. It is primarily used for:
- Data Automation: Automatically processing data based on predefined flows (e.g., updating related data after a new record is added to a table).
- Human-in-the-loop Processes: Integrating manual decision points, such as approvals or reviews, where the workflow pauses until a human submits a result.
- External System Integration: Interacting with third-party APIs using request nodes to exchange data with external systems.
Overview of Tachybase Variables
Variables in Tachybase are markers used to identify values within the current context. They are primarily used in the following scenarios: configuring block data ranges, setting field default values, defining linkage rules, and creating workflows.Overview of Tachybase Data Modeling and Integration
Tachybase provides an advanced data modeling platform that supports multi-source data integration, diverse data modeling interfaces, and a wide variety of specialized data table types. It uses a plugin-based architecture where a Data Source Management Plugin provides a unified interface to manage data sources, which must be paired with specific data source plugins to establish connections.Overview of Tachybase Main Database
The Tachybase main database stores business data and manages application metadata, including system and custom tables. It supports mainstream relational databases such as MySQL, PostgreSQL, and SQLite. This functionality is provided by themodule-collectionplugin, which is built-in and deployed automatically with Tachybase; it cannot be removed.Overview of DataSourceManager
TheDataSourceManageris used to manageDataSourceinstances and their associated templates, field interfaces, and mixins within the Tachybase client.Overview of Tachybase Workflow plugin
The Workflow plugin in tachybase is a no-code Business Process Management (BPM) tool used to orchestrate automated processes based on data models. It allows developers to implement business logic through a combination of a trigger and a series of execution nodes.
Common use cases include:
- Automated data processing: Automatically calculating or updating associated data after a record is added to a table.
- Manual intervention: Using manual-type nodes for processes requiring human decision-making, such as approvals or reviews.
- External system integration: Using Request nodes to call third-party API interfaces for data interaction.
Overview of Tachybase WYSIWYG Editing Mode
Tachybase is implementing a WYSIWYG editing experience inspired by collaborative tools like Lark and Notion. The goal is to move away from scattered operations and intrusive UI elements toward a 'non-intrusive editing' philosophy where editing tools serve the content without interfering with its display. Key improvements include real-time previews, inline editing, and a centralized entry point for all block-level operations.Overview of Tachybase WYSIWYG Editing Mode
Tachybase is implementing a WYSIWYG editing mode inspired by modern collaboration tools like Lark and Notion. The goal is to move away from fragmented toolbars, initializers, and settings menus toward a unified, non-intrusive interface where editing functions serve the content without interfering with its display. Key principles include real-time previews, inline editing, and a 'hover-to-activate' UI approach.