Skip to content

Latest commit

 

History

History
419 lines (337 loc) · 15.5 KB

README.md

File metadata and controls

419 lines (337 loc) · 15.5 KB

APITable封面图像

APITable Gitpod 开发环境 TypeScript 语言,NestJS 框架 Java 语言,Spring 框架
APITable License Badge AGPL

English | Français | Español | Deutsch | 简体中文 | 繁體中文 | 日本語

✨ 快速开始

如果你只是想试用一下 APITable1,那可以使用我们托管在 apitable.com的云端版本。

如果你想演示这个 APITable 开源项目,请单击此处获取⚡️Gitpod Online Demo

如果您想要在本地或云端计算环境中安装 APITable ,请参阅 💾 安装

如果你想要设置你的本地开发环境,请阅读我们的 🧑‍💻 开发者指南

加入 DiscordTwitter 保持联系。

🔥 功能特性

实时协作 Automatic Form
API 优先的面板 无限跨表关联
强大的行/列权限 Embed

APITable 提供了一系列令人惊奇的功能,从个人到企业。

  • 先进的技术栈并开源
    • 实时协作 允许多个用户实时或与 操作转换(OT) 算法同时进行编辑。
    • 使用 canvas 渲染的极其流畅、用户友好、极其快速的数据库-电子表格界面。
    • 数据库本地架构:变更集/操作/动作/快照等等。
    • 实时协作 100k+ 数据行
    • 数据(Data)元数据(MetaData) 的全栈式API访问。
    • 单向/双向表链接和 无限交叉链接
    • 社区友好的编程语言和框架,TypeScript (NextJS + NestJS) 和 Java (Spring Boot)
  • 美观和齐全的多维表格UI界面
    • CRUD: 创建、浏览、更新、删除表、列和行
    • 字段操作: 排序、过滤、分组、隐藏/取消隐藏、高度设置。
    • 基于空间(Space):使用分离的工作空间来代替基于 App/Base 的结构,使无限的表格连接成为可能。
    • 暗色模式 和主题定制。
    • 7 种视图类型: 网格视图(Datasheet) / 图库视图 / 脑图视图/ 看板视图 / 全功能网格视图 / 日历视图
    • 一键式 API 面板
  • Batteries included
    • 内置的 10+ 个官方模板
    • 机器人自动化和自定义配置
    • BI 仪表板
    • 一键式自动生成表单
    • 可共享和嵌入的页面
    • 多语言支持
    • 集成 n8n.io / Zapier / Appsmith... 及更多
  • 卓越的扩展性
    • 超过 20 个官方开源组件,以及可扩展的 组件系统
    • 可自定义的图表 & 仪表板
    • 可自定义的数据列类型
    • 可自定义的公式
    • 可自定义的自动化机器人行为
  • 企业级权限
    • 镜像, 将视图变成镜像以实现行权限
    • 通过非常简单的操作激活 列权限
    • 文件夹/子文件夹/文件权限
    • 树结构文件夹和可自定义的节点(文件)
    • 团队管理 & 组织架构
  • Enterprise features:
    • SAML
    • 单点登录(SSO)
    • 审计
    • 数据库自动备份
    • 数据导出
    • 水印
  • ....

使用可扩展的组件和插件,您可以添加更多功能。

💥 Use Cases

为什么你必须知道 APITable 并作为你的下一个软件?

  • 作为超级管理软件
    • 灵活的项目管理 & 任务/问题管理
    • 营销潜在客户管理。
    • 最灵活和可连接的 CRM
    • 商业化智能(BI)仪表板
    • 便于人们使用的表格和调查表
    • 灵活的 ERP
    • 低代码和无代码平台。
    • ...及更多, APITable 将 1000 个软件放入您的口袋中。
  • 作为一个可视化数据库基础设施
    • 将 APITable 嵌入 到你自己的软件 UI 中
    • 带有 REST API 的可视化数据库
    • 管理员仪表板
    • 集中管理配置
    • 多合一的企业数据库,连接你的所有 软件
    • ...及更多, APITable 连接一切
  • 此外,它是开源和可扩展的

💞 面向 API

API 面板

点击右角的 API 按钮将显示 API 面板

SQL式查询

APITable 将提供一个数据表查询语言(DQL)来查询您的数据库电子表格内容。

💝 Embed-friendly

分享和嵌入

分享您的数据表或文件夹。 通过复制和粘贴 HTML 脚本嵌入它们。

企业可用的嵌入

APITable.com 为证券业提供更多企业可用的嵌入功能。

安装

在您开始之前

  • 安装 docker 和 docker-compose v2 的主机。
  • 有4 个或更多 CPU/8GB RAM。
  • 一个安装了 curl 等基本实用程序的 bash shell。
  • 原生 arm64 (apple silicon) 容器镜像尚未就绪,可能会导致性能不佳。

要使用 docker compose 安装 apitable,请打开您的终端并运行:

curl https://apitable.github.io/install.sh | bash

然后在您的浏览器中打开 http://localhost:80 访问它。

我们还提供了一个基于 pm2 的完整镜像,用于演示或测试目的(不推荐用于企业或生产用途):

sudo docker run -d -v ${PWD}/.data:/apitable -p 80:80 --name apitable apitable/all-in-one:latest

根据您的环境,您可能需要等待几分钟才能开始所有服务。 该镜像只在amd64 (x86_64) 下,你可能会在arm64 或 apple silicon 上遇到相当坏的性能。

如果您想在本地开发环境启动,请阅读我们的 🧑‍💻 开发者指南

🧑‍💻 贡献

欢迎并感谢您为 APITable 作出贡献!

In addition to writing code, there are many ways for you to contribute.

你可以通过如下方式给项目提供帮助:

Such as the following:

You can read this repository’s Contributing Guidelines to learn how to contribute.

这是一份入门指南,让您快速了解如何为 APITable 的茁壮成长贡献力量。

开发环境

在我们的 开发者指南 中学习如何设置您的本地开发环境。

Git 工作流基础

下面是通用的 APITable 工作流:

  1. 创建一个问题并描述您想要的功能 -> APITable 问题
  2. 派生此项目 -> Fork APITable 项目
  3. 创建您的功能分支(git checkout -b my-new-feature)
  4. 提交您的更改(git commit -am 'Add some features')
  5. 推送分支 (git push origin my-new-feature)
  6. 创建新的拉取请求 -> 通过派生创建拉取请求

工作约定

APITable 可适用这些通用的约定:

文档

🛣 规划路线

请参考 路线图

未来的功能

  • 重代码界面生成器
  • 可嵌入的第三方文档组件
  • SQL-like Domain-Specific Languages
  • 作为一个 IdP
  • 先进的自动化机器人
  • Web 3 features
  • ...

托管服务版和企业版提供高级功能

  • 作为一个 IdP
  • SAML
  • 单点登录
  • 审计
  • 数据库备份
  • 与ChatGPT、Zapier、Slack、Google Workspace等软件集成
  • 水印

For more information on our product, including enterprise self-hosted license, please contact us at [email protected] or book a demo.

👫 参与进来

🌏 我们为什么要创建 APITable 并开源?

  • 我们认为 数据库是所有软件的基石
  • 我们相信,为每个人制作一个具有丰富和简单用户界面的可视化数据库,可以降低软件行业的难度,提高世界数字化的应用
  • 我们相信开源 APITable 可以 推动人类前进

我们正在招聘远程工作的开发者!

我们一直在为 APITable 寻找优秀人才:

  • 全栈开发者: 有 React、NextJS、TypeScript、Spring Boot、Java、Terraform 的工作经验。 并喜欢写高质量的代码,带有清晰的文档和单元测试。
  • 后端开发者: 有 NestJS、TypeScript、Spring Boot、Java、SQL、Kubernetes、Terraform 的工作经验。 并喜欢写高质量的代码,带有清晰的文档和单元测试。
  • 前端开发者: 有 React、NextJS、TypeScript、WebPack 的工作经验。 And you like to write high quality code with clear documentation and unit tests.

无论时间和条件如何,如果你想要加入 APITable 团队,请不要犹豫,将您的简历发送到 [email protected]

📺 截图

APITable屏幕截图图像

APITable屏幕截图图像

APITable屏幕截图图像

APITable屏幕截图图像

APITable屏幕截图图像

APITable屏幕截图图像

APITable屏幕截图图像

APITable屏幕截图图像

APITable屏幕截图图像

APITable Screenshot Image

🥰 许可协议

此仓库包含在 AGPL 下发布的 Open Source 版本的 APITable源代码。

如果你想运行你自己的 APITable 副本或对发展作出贡献,那这里就是你的地方。

详情请参阅 LICENSING

如果您想要在线使用 APITable ,那么您不需要运行此代码。 我们在 APITable 上提供一个托管的应用版本 适合全球加速。


Footnotes

  1. 使用AGPL-3.0授权。 由 APITable Ltd设计。