Teable logo

An AI native visualization database that empowers everyone

We believe that databases will become the infrastructure of generative AI in the same way as computing power. By utilizing database capabilities, every enterprise, organization, and even individual can train their own private AI assistant to gain a competitive edge.

build Codefactor Maintainability Techdebt Codacy grade LoC GitHub top language Licence

# ✨Features ### 🧠 Teable Copilot Native Integrated AI, Powered by GPT-3.5-turbo - Chat 2 App. "Create a project management app for me" - Chat 2 Chart. "Analyze the data in the order table using a bar chart" - Chat 2 View. "I want to see the schedule for the past week and only display participants" - Chat 2 Action. "After the order is paid and completed, an email notification will be sent to the customer" ### πŸ”’ Privacy-First You own your data, in spite of the cloud - Data storage local first - Offline desktop client support - Sync & collaboration to cloud in just one click ### πŸš€ Super Fast Build in minutes scale to millions - Support for data sets of over one million rows - Support database indexes - Support server side render ### ⚑️ Real-time collaboration Designed for teams - Seamless real-time collaboration among multiple people - Thoughtful and detailed permission control ability ### 🧩 Extensions Expand infinite possibilities - Backend-less programming capability based on React - Customize your own application with extremely low cost - Extremely easy-to-use script extensions mode ### πŸ€– Automation Empower data-driven workflows effortlessly and seamlessly - Design your workflow with AI or Visual programming - Super easy retrieve data from table ### πŸ‘¨β€πŸ’» Full-featured SQL Support Seamless integration with the software you are familiar with - BI tools like Metabase PowerBi... - No-code tools like appsmith... - Direct retrieve data with native sql ### πŸ—„οΈ Database adapter Choose the database you like - Sqlite, PostgreSQL, MySQL, TiDB, Snowflake... # Structure [![Open in Gitpod](https://img.shields.io/badge/Open%20In-Gitpod.io-%231966D2?style=for-the-badge&logo=gitpod)](https://gitpod.io/#https://github.com/teable-group/teable) ``` . β”œβ”€β”€ apps β”‚ β”œβ”€β”€ nextjs-app (front-end, include web and electron app ) β”‚ └── nestjs-backend (backend, running on server or inside electron app) └── packages β”œβ”€β”€ common-i18n (locales...) β”œβ”€β”€ core (share code and interface between app and backend) β”œβ”€β”€ sdk (sdk for extensions) β”œβ”€β”€ db-main-prisma (schema, migrations, prisma client) β”œβ”€β”€ eslint-config-bases (to shared eslint configs) └── ui-lib (storybook) ``` # Run Project #### 1. Install ```sh yarn install ``` #### 2. DB migration ```sh cd packages/db-main-prisma # generate ts interface yarn prisma generate # create db schema yarn prisma-db-push # fill seed data yarn prisma-db-seed ``` #### 3. Config .env file config openai ai endpoint and key ```sh cd apps/nextjs-app copy .env.example .env.development.local ``` open .env.development.local > OpenAI is not available in some country. To solve this problem, we recommend using https://api-openai.teable.io as an endpoint. This is an unrestricted proxy deployed on Vercel. ``` OPENAI_API_KEY=your-api-key OPENAI_API_ENDPOINT=openai-endpoint ``` #### 4. Run dev server you should only start backend, it will start next server for front-end automatically, file change will be auto reload ```sh cd apps/nestjs-backend tsc --build --watch # run in a new terminal yarn dev ``` # Developers Goto [developer readme](./DEVELOPER.md) ## Sponsors :heart: If you are enjoying some this project in your company, I'd really appreciate a [sponsorship](https://github.com/sponsors/teable-group), a [coffee](https://ko-fi.com/teable-group) or a dropped star. That gives me some more time to improve it to the next level. # License AGPL-3.0