diff --git a/.github/workflows/verify.yml b/.github/workflows/verify.yml index 019dcbcb..074b4252 100644 --- a/.github/workflows/verify.yml +++ b/.github/workflows/verify.yml @@ -4,9 +4,15 @@ on: push: branches: - main + paths: + - frontend/** + - README.md pull_request: branches: - main + paths: + - frontend/** + - README.md jobs: verify-frontend: @@ -20,6 +26,13 @@ jobs: uses: actions/checkout@v4 - uses: pnpm/action-setup@v4 with: - run_install: true + run_install: false package_json_file: ./frontend/package.json + - name: Install Node.js + uses: actions/setup-node@v4 + with: + node-version-file: ./frontend/.nvmrc + cache-dependency-path: ./frontend + cache: 'pnpm' + - run: pnpm i --frozen-lockfile - run: pnpm run verify diff --git a/README.md b/README.md index 49acc1a4..14f33bb5 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,8 @@ ## Introduction A conversational search tool based on GraphRAG (Knowledge Graph) that built on top of [TiDB Vector](https://tidb.cloud/ai) and [LlamaIndex](https://github.com/run-llama/llama_index) and [DSPy](https://github.com/stanfordnlp/dspy). -**Live Demo**: [TiDB.AI](https://tidb.cloud/?utm_source=github&utm_medium=tidb.ai) - -**Documentation**: [TiDB.AI Docs](https://tidb.ai/docs/?utm_source=github&utm_medium=tidb.ai) +* **Live Demo**: [TiDB.AI](https://tidb.cloud/?utm_source=github&utm_medium=tidb.ai) +* **Documentation**: [Docs](https://tidb.ai/docs/?utm_source=github&utm_medium=tidb.ai) ## Features 1. **Perplexity-style Conversational Search page**: Our platform features an advanced built-in website crawler, designed to elevate your browsing experience. This crawler effortlessly navigates official and documentation sites, ensuring comprehensive coverage and streamlined search processes through sitemap URL scraping. @@ -27,17 +26,11 @@ You can even edit the Knowledge Graph to add more information or correct any ina ## Tech Stack -- [Next.js](https://nextjs.org/) – Framework -- [TypeScript](https://www.typescriptlang.org/) – Language -- [Tailwind](https://tailwindcss.com/) – CSS -- [shadcn/ui](https://ui.shadcn.com/) - Design -- [TiDB](https://tidb.cloud/) – Database to store chat history, vector, json, and analytic -- [Kysely](https://kysely.dev/) - SQL query builder -- [NextAuth.js](https://next-auth.js.org/) – Auth -- [Vercel](https://vercel.com/) – Deployments +- [TiDB](https://pingcap.com/ai/?utm_source=github&utm_medium=tidb.ai) – Database to store chat history, vector, json, and analytic - [LlamaIndex](https://www.llamaindex.ai/) - RAG framework - [DSPy](https://github.com/stanfordnlp/dspy) - The framework for programming—not prompting—foundation models -- [TiDB Vector](https://tidb.cloud/ai) - Vector storage and search engine +- [Next.js](https://nextjs.org/) – Framework +- [shadcn/ui](https://ui.shadcn.com/) - Design ## Contect Us You can post topics on our [TiDB Community](https://ask.pingcap.com/) page. diff --git a/frontend/app/src/pages/docs/README.md b/frontend/app/src/pages/docs/README.md deleted file mode 100644 index a88ccb7c..00000000 --- a/frontend/app/src/pages/docs/README.md +++ /dev/null @@ -1,44 +0,0 @@ -
-

TiDB.AI

- - TiDB.AI - -
- -## Introduction -A conversational search tool based on GraphRAG (Knowledge Graph) that built on top of [TiDB Vector](https://tidb.cloud/ai) and [LlamaIndex](https://github.com/run-llama/llama_index) and [DSPy](https://github.com/stanfordnlp/dspy). - -**Live Demo**: [TiDB.AI](https://tidb.cloud/?utm_source=github&utm_medium=tidb.ai) - -**Documentation**: [TiDB.AI Docs](https://tidb.ai/docs/?utm_source=github&utm_medium=tidb.ai) - -## Features -1. **Perplexity-style Conversational Search page**: Our platform features an advanced built-in website crawler, designed to elevate your browsing experience. This crawler effortlessly navigates official and documentation sites, ensuring comprehensive coverage and streamlined search processes through sitemap URL scraping. - -![out-of-box-conversational-search](https://github.com/pingcap/tidb.ai/assets/1237528/9cc87d32-14ac-47c6-b664-efa7ec53e751 "Image Title") - -You can even edit the Knowledge Graph to add more information or correct any inaccuracies. This feature is particularly useful for enhancing the search experience and ensuring that the information provided is accurate and up-to-date. - -![out-of-box-conversational-search](https://github.com/pingcap/tidb.ai/assets/1237528/7bc57b34-99b7-4c4b-a098-9ad33dd0dfdc "Image Title") - -2. **Embeddable JavaScript Snippet**: Integrate our conversational search window effortlessly into your website by copying and embedding a simple JavaScript code snippet. This widget, typically placed at the bottom right corner of your site, facilitates instant responses to product-related queries. - -![embeddable-javascript-snippet](https://github.com/pingcap/tidb.ai/assets/1237528/5a445231-a27a-4ae6-8287-a4f8cf7b64d0 "Image Title") - - -## Tech Stack -- [Next.js](https://nextjs.org/) – Framework -- [TypeScript](https://www.typescriptlang.org/) – Language -- [Tailwind](https://tailwindcss.com/) – CSS -- [shadcn/ui](https://ui.shadcn.com/) - Design -- [TiDB](https://tidb.cloud/) – Database to store chat history, vector, json, and analytic -- [Kysely](https://kysely.dev/) - SQL query builder -- [NextAuth.js](https://next-auth.js.org/) – Auth -- [Vercel](https://vercel.com/) – Deployments -- [LlamaIndex](https://www.llamaindex.ai/) - RAG framework -- [DSPy](https://github.com/stanfordnlp/dspy) - The framework for programming—not prompting—foundation models -- [TiDB Vector](https://tidb.cloud/ai) - Vector storage and search engine - - -## License -TiDB.AI is open-source under the Apache License, Version 2.0. You can [find it here](/LICENSE.txt). diff --git a/frontend/app/src/pages/docs/README.md b/frontend/app/src/pages/docs/README.md new file mode 120000 index 00000000..1dfab242 --- /dev/null +++ b/frontend/app/src/pages/docs/README.md @@ -0,0 +1 @@ +../../../../../README.md \ No newline at end of file diff --git a/frontend/app/src/pages/docs/changelog.mdx b/frontend/app/src/pages/docs/changelog.mdx index 7bc93693..5bde456b 100644 --- a/frontend/app/src/pages/docs/changelog.mdx +++ b/frontend/app/src/pages/docs/changelog.mdx @@ -2,6 +2,13 @@ Latest updates and announcements. +## July 22nd, 2024 - Refactor core from JavaScript to Python + +- **Core Enhancements:** + - Refactor the core from JavaScript to Python. + - [x] Graph RAG (Knowledge Graph) core + - [x] LlamaIndex core + ## May 29th, 2024 - Add Knowledge Graph as secondary set of corpus - **Core Enhancements:** diff --git a/frontend/package.json b/frontend/package.json index 275e1f75..448fc5c4 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -2,7 +2,7 @@ "name": "tidb-ai-parent", "private": true, "version": "0.0.0", - "packageManager": "pnpm@9.4.0", + "packageManager": "pnpm@9.6.0", "license": "Apache-2.0", "scripts": { "test": "pnpm run --filter '*' test",