teable/README.md

171 lines
6.1 KiB
Markdown
Raw Normal View History

2022-11-01 09:36:07 +00:00
<div align="center">
2023-03-31 20:37:09 +00:00
<h1 align="center"><a aria-label="NextJs Monorepo" href="https://github.com/teable-group/teable"><img height="100px" src="static/assets/images/teable-vertical-linear.png" alt="Teable logo" /></a></h1>
2023-03-31 20:29:20 +00:00
<h3 align="center"><strong>An AI native visualization database that empowers everyone</strong></h3>
<p>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.</p>
2022-11-01 09:36:07 +00:00
</div>
<p align="center">
<a aria-label="Build" href="https://github.com/teable-group/teable/actions?query=workflow%3ACI">
<img alt="build" src="https://img.shields.io/github/workflow/status/teable-group/teable/CI-nextjs-app/main?label=CI&logo=github&style=flat-quare&labelColor=000000" />
</a>
<a aria-label="Codefactor grade" href=https://www.codefactor.io/repository/github/teable-group/teable">
<img alt="Codefactor" src="https://img.shields.io/codefactor/grade/github/teable-group/teable?label=Codefactor&logo=codefactor&style=flat-quare&labelColor=000000" />
</a>
<a aria-label="CodeClimate maintainability" href="https://codeclimate.com/github/teable-group/teable">
<img alt="Maintainability" src="https://img.shields.io/codeclimate/maintainability/teable-group/teable?label=Maintainability&logo=code-climate&style=flat-quare&labelColor=000000" />
</a>
<a aria-label="CodeClimate technical debt" href="https://codeclimate.com/github/teable-group/teable">
<img alt="Techdebt" src="https://img.shields.io/codeclimate/tech-debt/teable-group/teable?label=TechDebt&logo=code-climate&style=flat-quare&labelColor=000000" />
</a>
<a aria-label="Codacy grade" href="https://www.codacy.com/gh/teable-group/teable/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=teable-group/teable&amp;utm_campaign=Badge_Grade">
<img alt="Codacy grade" src="https://img.shields.io/codacy/grade/dff9c944af284a0fad4e165eb1727467?logo=codacy&style=flat-square&labelColor=000&label=Codacy">
</a>
<a aria-label="LoC">
<img alt="LoC" src="https://img.shields.io/tokei/lines/github/teable-group/teable?style=flat-quare&labelColor=000000" />
</a>
<a aria-label="Top language" href="https://github.com/teable-group/teable/search?l=typescript">
<img alt="GitHub top language" src="https://img.shields.io/github/languages/top/teable-group/teable?style=flat-square&labelColor=000&color=blue">
</a>
<a aria-label="Licence" href="https://github.com/teable-group/teable/blob/main/LICENSE">
<img alt="Licence" src="https://img.shields.io/github/license/teable-group/teable?style=flat-quare&labelColor=000000" />
</a>
</p>
2023-03-31 20:29:20 +00:00
# ✨Features
2023-03-31 20:37:09 +00:00
### 🧠 Teable Copilot
Native Integrated AI, Powered by GPT-3.5-turbo
2023-03-31 20:29:20 +00:00
2023-04-01 04:47:24 +00:00
- 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"
2023-03-31 20:29:20 +00:00
2023-03-31 20:37:09 +00:00
### 🔒 Privacy-First
You own your data, in spite of the cloud
2023-03-31 20:29:20 +00:00
2023-04-01 04:47:24 +00:00
- Data storage local first
- Offline desktop client support
- Sync & collaboration to cloud in just one click
2023-03-31 20:29:20 +00:00
2023-03-31 20:37:09 +00:00
### 🚀 Super Fast
2023-04-01 04:47:24 +00:00
Build in minutes scale to millions
2023-03-31 20:29:20 +00:00
2023-04-01 04:47:24 +00:00
- Support for data sets of over one million rows
- Support database indexes
2023-03-31 20:29:20 +00:00
- Support server side render
2023-03-31 20:37:09 +00:00
### ⚡️ Real-time collaboration
Designed for teams
2023-03-31 20:29:20 +00:00
2023-04-01 04:47:24 +00:00
- Seamless real-time collaboration among multiple people
2023-03-31 20:29:20 +00:00
- Thoughtful and detailed permission control ability
2023-03-31 20:37:09 +00:00
### 🧩 Extensions
Expand infinite possibilities
2023-03-31 20:29:20 +00:00
- Backend-less programming capability based on React
2023-04-01 04:47:24 +00:00
- Customize your own application with extremely low cost
2023-03-31 20:29:20 +00:00
- Extremely easy-to-use script extensions mode
2023-03-31 20:37:09 +00:00
### 🤖 Automation
2023-04-01 04:47:24 +00:00
Empower data-driven workflows effortlessly and seamlessly
2023-03-31 20:29:20 +00:00
2023-03-31 20:37:09 +00:00
- Design your workflow with AI or Visual programming
- Super easy retrieve data from table
2023-03-31 20:29:20 +00:00
2023-03-31 20:37:09 +00:00
### 👨‍💻 Full-featured SQL Support
2023-04-01 04:47:24 +00:00
Seamless integration with the software you are familiar with
2023-03-31 20:29:20 +00:00
- BI tools like Metabase PowerBi...
2023-03-31 20:37:09 +00:00
- No-code tools like appsmith...
2023-03-31 20:29:20 +00:00
- Direct retrieve data with native sql
2023-03-31 20:37:09 +00:00
### 🗄️ Database adapter
Choose the database you like
2023-03-31 20:29:20 +00:00
- Sqlite, PostgreSQL, MySQL, TiDB, Snowflake...
# Structure
2022-11-01 09:36:07 +00:00
[![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 )
2023-03-31 20:37:09 +00:00
│ └── nestjs-backend (backend, running on server or inside electron app)
2022-11-01 09:36:07 +00:00
└── packages
├── common-i18n (locales...)
├── core (share code and interface between app and backend)
├── sdk (sdk for extensions)
2023-02-04 09:47:26 +00:00
├── db-main-prisma (schema, migrations, prisma client)
2022-11-01 09:36:07 +00:00
├── eslint-config-bases (to shared eslint configs)
└── ui-lib (storybook)
2022-11-01 09:36:07 +00:00
```
2023-03-31 20:29:20 +00:00
# Run Project
2022-11-01 09:36:07 +00:00
2023-03-31 20:37:09 +00:00
#### 1. Install
2022-11-01 09:36:07 +00:00
```sh
yarn install
2022-11-01 09:36:07 +00:00
```
2023-03-31 20:37:09 +00:00
#### 2. DB migration
2022-11-01 09:36:07 +00:00
```sh
cd packages/db-main-prisma
yarn prisma-db-push
yarn prisma-migrate dev
2023-04-13 09:43:03 +00:00
yarn prisma-db-seed
2022-11-01 09:36:07 +00:00
```
#### 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
2022-11-01 09:36:07 +00:00
you should only start backend, it will start next server for front-end automatically
2022-11-01 09:36:07 +00:00
```sh
cd apps/nestjs-backend
2023-04-01 04:39:49 +00:00
tsc --build
yarn dev
2022-11-01 09:36:07 +00:00
```
2023-03-31 20:29:20 +00:00
# Developers
2022-11-01 09:36:07 +00:00
2023-03-31 20:29:20 +00:00
Goto [developer readme](./DEVELOPER.md)
2022-11-01 09:36:07 +00:00
## Sponsors :heart:
2022-11-01 09:36:07 +00:00
2023-04-01 04:47:24 +00:00
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.
2022-11-01 09:36:07 +00:00
2023-03-31 20:29:20 +00:00
# License
2022-11-01 09:36:07 +00:00
AGPL-3.0