apitable: A TypeScript repository from wuwx

✨ Quick Start

APITable is currently a Work In Progress.

We will publish the first release in late January 2023.

Join Discord or Twitter to keep in touch.

If you just want to try out APITable¹, click here for ⚡️Gitpod Online Demo.

If you want to install APITable in your local or cloud computing environment, see 💾 Installation

🔥 Features

Realtime Collaboration	Automatic Form

API-first Panel	Unlimited cross-table links

Powerful Rows/Columns Permissions	Embed

APITable provides a range of amazing features, from the personal to the enterprise.

Advanced technology stack and open-source
- Realtime collaboration allows multiple users to edit together in real time, or simultaneously with the Operational Transformation (OT) Algorithm.
- Extremely smooth, user-friendly, super-fast database-spreadsheet interface in <canvas> Rendering Engine.
- Database native architecture: Changeset / Operation / Action / Snapshot and so on.
- 100k+ data rows with real-time collaboration.
- Full-stack API access, from Data to Metadata.
- One-direction / Bi-direction Table Link and Infinite Cross Links
- Community-friendly programming languages and framework, TypeScript (NextJS + NestJS) and Java (Spring Boot)
Beautiful and Rich Database-Spreadsheet UI
- CRUD: Create, Read, Update, Delete the Tables, Columns, and Rows
- Fields Operations: sort, filter, grouping, hide/unhide, height setting.
- Space based: Use separated workspaces in place of App/Base-based structure, make unlimited tables link together possible.
- Dark mode and theme customization available.
- 7 View Types: Grid View (Datasheet) / Gallery View / Mindmap View / Kanban View / Full-Feature Gantt View / Calendar View
- One-click API Panel
Batteries included
- Built-in 10+ official templates.
- Robot Automation and customization available.
- BI dashboard
- One-click auto-generated form
- Shareable and embeddable page.
- Multi-language support.
- Integration with n8n.io / Zapier / Appsmith... and more.
Excellent extensibility
- Extensible Widget System with over 20 officials open-source widgets.
- Customizable Graph & Chart & Dashboard
- Customizable Data Column Types
- Customizable Formulas
- Customizable Automation Robot Actions.
Enterprise-grade permissions
- Mirror, turn a View into a mirror to implement Row Permission.
- Activate Column Permission through a very simple operation.
- Folders / Sub-Folders / Files Permission.
- Tree structure folders and customizable node (file);
- Team Management & Organization Structure.
Enterprise features:
- SAML
- Single-Sign-On (SSO)
- Audit
- Database Auto Backup
- Data Exporter
- Watermark
....

With extensible widgets and plugins, you can add more features.

💥 Use Cases

Why you must know APITable for your next software?

As super management software
- Flexible Project Management & Tasks / Issues Management.
- Marketing Lead Management.
- Most flexible and connectable CRM.
- Flexible Business Intelligence (BI).
- People-Friendly Forms and Surveys
- Flexible ERP.
- Low-code and no-code platform.
- ...and more, APITable puts 1000 softwares in your pocket.
As a visual database infrastructure
- Embed APITable into your own software UIs.
- Visual Database with REST API.
- Admin dashboard.
- Central configuration management.
- All-in-one enterprise database that connect all your software.
- ...and more, APITable connects everything.
Also, it is open source and extensible

💞 API-oriented

API UI Panel

Clicking the API button in the right corner will show the API Panel

SQL-like query

APITable will provides a Datasheet Query Language (DQL) to query your database-spreadsheet contents.

💝 Embed-friendly

Share and Embed

Share your datasheet table or folder. Embed them by copying and pasting HTML scripts.

Enterprise-ready Embedding

APITable.com provides more Enterprise-ready Embedding features for securities.

Installation

Make sure you have docker & curl installed locally.

If you computer has installed Docker Machine, open your terminal and run this:

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

Then open https://localhost:80 in your browser to visit it. (default username admin@apitable.com and password Apitable2022)

If you want to set up your local development environment, read our Developer Guide

🧑‍💻 Contributing

Welcome, and thank you for your interest in contributing to APITable!

There are many ways in which you can contribute, beyond writing code.

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

Here's a quick guide to help you contribute to APITable.

Development environment

Learn how to set up your local environment, in our Developer Guide.

Git workflow basic

Here's a general APITable git workflow:

Create an issue and describe features you want -> APITable issues
Fork this project -> Fork APITable project
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some features')
Publish the branch (git push origin my-new-feature)
Create a new Pull Request -> Create pull request across forks

Work conventions

APITable use these common conventions:

What's our Git branching model? Gitflow
How to collaborate on your fork projects? Github Flow
How to write good commit message? Conventional Commits
What's our changelog format? Keep Changelog
How to versioning and tagging? Semantic Versioning
What is the Java Coding Guideline? Java Coding Guideline | Intellij IDEA Plugin
What is the TypeScript Coding Guideline? -> TypeScript Style Guide | ESLint

Documentations

Help Center (coming soon...)
👩‍💻 Developer Center
- 🪡 REST API Docs
- Widget SDK (Coming soon...)
- Scripting (Coming soon...)

🛣 Roadmap

Future Features

Heavy-code Interface Builder
Embbedable 3rd party documentation components
SQL-like Domain-Specific Languages
As an IdP
Web 3 features
...

Hosted and Enterprise versions offer advanced features

As an IdP;
SAML
Single-Sign-On
Audit
Database Backup
Watermark

For more information, please contact us at support@apitable.com.

👫 Get Involved

🌏 Why we create APITable and open-source?

We believe that Database is the cornerstone of all the software.
We believe that making a Visual Database with rich and easy user interface for everyone can reduce the difficulty of software industry and increase the world's digitalization adoption.
We believe that open-sourcing APITable work can Push Human Beings Forward.

We are hiring remotely!

We always search for good talents for APITable:

Full-stack developer: You have experience with React, NestJS, TypeScript, Spring Boot, Java, Terraform. And you like to write high quality code with clear documentation and unit tests.
Back-end developer: You have experience with NestJS, TypeScript, Spring Boot, Java, SQL, Kubernetes, Terraform. And you like to write high quality code with clear documentation and unit tests.
Front-end developer: You have experience with React, NextJS, TypeScript, WebPack. And you like to write high quality code with clear documentation and unit tests.

Regardless of time and conditions, if you want to get involved to the team of APITable, do not hesitate and send your CV to talent@apitable.com.

📺 Screenshot

🥰 License

This repository contains the source code for the Open Source edition of APITable, released under the AGPL.

If you'd like to run your own copy of APITable or contribute to development then this is the place for you.

See LICENSING for details.

If you want to use APITable online then you don't need to run this code, we offer a hosted version of the app at APITable.com which optimized for global accelerator.

Licensed with AGPL-3.0. Designed by APITable Ltd. ↩

wuwx/apitable