{"id":24938707,"url":"https://github.com/tidbcloud/examples-projects","last_synced_at":"2025-07-23T01:34:16.329Z","repository":{"id":272276943,"uuid":"901647466","full_name":"tidbcloud/examples-projects","owner":"tidbcloud","description":"A collection of examples demonstrating how to connect and use TiDB Cloud.","archived":false,"fork":false,"pushed_at":"2025-05-08T14:37:06.000Z","size":3983,"stargazers_count":5,"open_issues_count":8,"forks_count":4,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-05-08T15:25:40.232Z","etag":null,"topics":["mysql","tidb","tidbcloud"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tidbcloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-11T03:51:17.000Z","updated_at":"2025-04-05T01:15:54.000Z","dependencies_parsed_at":"2025-01-13T12:32:54.010Z","dependency_job_id":"10bbd53c-e53a-41ce-9a54-c7f62d205d43","html_url":"https://github.com/tidbcloud/examples-projects","commit_stats":null,"previous_names":["tidbcloud/examples-projects"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tidbcloud/examples-projects","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Fexamples-projects","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Fexamples-projects/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Fexamples-projects/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Fexamples-projects/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tidbcloud","download_url":"https://codeload.github.com/tidbcloud/examples-projects/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Fexamples-projects/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266602820,"owners_count":23954696,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mysql","tidb","tidbcloud"],"created_at":"2025-02-02T17:59:36.082Z","updated_at":"2025-07-23T01:34:16.305Z","avatar_url":"https://github.com/tidbcloud.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# TiDB Cloud Examples\n\nA collection of examples demonstrating how to connect and use TiDB Cloud.\n\n## Getting Started\n\nThese examples are built with modern web development tools and practices. Before you begin, make sure you have the following prepared:\n\n### Prerequisites\n\n- Node.js 20.x or later\n- pnpm 9.x or later (we use pnpm workspaces to manage multiple examples)\n- A [TiDB Cloud](https://tidbcloud.com) account (free tier available, no credit card required)\n\n### Installation\n\n1. Clone the repository:\n\n```bash\ngit clone https://github.com/tidbcloud/examples-projects.git\n```\n\n2. Install dependencies:\n\n```bash\npnpm install\n```\n\n3. Each example has its own environment variables that need to be configured. Check the README in each example directory for specific setup instructions.\n\n4. If you only want to clone a single example, you can use the following command:\n\n```bash\nnpx degit tidbcloud/examples-projects/examples/with-chat2query-api my-example\n```\n\nThen cd into that example directory and run `pnpm install`.\n\nYou can also replace **with-chat2query-api** with the name of the example you want to clone, for example:\n\n```bash\nnpx degit tidbcloud/examples-projects/examples/with-data-api my-example\nnpx degit tidbcloud/examples-projects/examples/with-nextjs-todo my-example\nnpx degit tidbcloud/examples-projects/examples/with-vector-search my-example\n```\n\nEach project requires a `.env` file to be created in the root of the example directory. You can refer to the README in each example directory for more details.\n\n## Examples\n\n### Next.js Todo App\n\nA full-stack todo application built with Next.js, demonstrating how to connect and use TiDB Cloud Serverless with Drizzle ORM.\n[Learn more](./examples/with-nextjs-todo/README.md)\n\n### Data Service Dashboard\n\nA dashboard application showcasing TiDB Cloud Data Service for building APIs without backend code.\n[Learn more](./examples/with-data-api/README.md)\n\n### Chat2Query Interface\n\nAn AI-powered SQL chat interface using TiDB Cloud's Chat2Query API to generate and execute queries.\n[Learn more](./examples/with-chat2query-api/README.md)\n\n### Vector Search RAG\n\nA RAG (Retrieval Augmented Generation) application demonstrating TiDB's vector search capabilities.\n[Learn more](./examples/with-vector-search/README.md)\n\n## Features Demonstrated\n\n- TiDB Cloud Serverless database connection\n- Data Service for serverless APIs\n- Chat2Query for natural language SQL queries\n- Vector search for semantic search and RAG applications\n- TypeScript \u0026 Next.js integration\n- tRPC for type-safe APIs\n- Drizzle ORM for database operations\n\n## Need Help?\n\nRun into issues or have questions? We're here to help!\n\n- Open an issue in our [GitHub repository](https://github.com/tidbcloud/examples-projects/issues/new)\n- Include details about:\n  - Which example you're using\n  - What you're trying to do\n  - Any error messages you're seeing\n  - Your environment (Node.js version, OS, etc.)\n\nOur team actively monitors issues and will help you get up and running.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftidbcloud%2Fexamples-projects","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftidbcloud%2Fexamples-projects","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftidbcloud%2Fexamples-projects/lists"}