{"id":14372009,"url":"https://github.com/chartdb/chartdb","last_synced_at":"2025-05-14T08:04:54.359Z","repository":{"id":254603672,"uuid":"838212912","full_name":"chartdb/chartdb","owner":"chartdb","description":"Database diagrams editor that allows you to visualize and design your DB with a single query.","archived":false,"fork":false,"pushed_at":"2025-05-04T10:48:14.000Z","size":64239,"stargazers_count":16342,"open_issues_count":97,"forks_count":825,"subscribers_count":57,"default_branch":"main","last_synced_at":"2025-05-07T07:15:01.158Z","etag":null,"topics":["database","db","db-migration","editor","erd","mariadb","mssql","mysql","postgresql","react","react-flow","schema-migrations","sql","sqlite","typescript","visualization","xyflow"],"latest_commit_sha":null,"homepage":"https://chartdb.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chartdb.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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-08-05T07:19:19.000Z","updated_at":"2025-05-07T04:27:12.000Z","dependencies_parsed_at":"2024-08-24T18:06:14.593Z","dependency_job_id":"958f4615-a9b6-4019-8a7d-c3a062c041ef","html_url":"https://github.com/chartdb/chartdb","commit_stats":{"total_commits":342,"total_committers":27,"mean_commits":"12.666666666666666","dds":"0.38888888888888884","last_synced_commit":"fa346ae6073411911b58f1d03d8ed1a388251555"},"previous_names":["chartdb/chartdb"],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chartdb%2Fchartdb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chartdb%2Fchartdb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chartdb%2Fchartdb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chartdb%2Fchartdb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chartdb","download_url":"https://codeload.github.com/chartdb/chartdb/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254101586,"owners_count":22014907,"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","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":["database","db","db-migration","editor","erd","mariadb","mssql","mysql","postgresql","react","react-flow","schema-migrations","sql","sqlite","typescript","visualization","xyflow"],"created_at":"2024-08-27T23:01:37.992Z","updated_at":"2025-05-14T08:04:54.233Z","avatar_url":"https://github.com/chartdb.png","language":"TypeScript","readme":"\u003ch1 align=\"center\"\u003e\n  \u003ca href=\"https://chartdb.io#gh-light-mode-only\"\u003e\n    \u003cimg src=\"https://github.com/chartdb/chartdb/blob/main/src/assets/logo-light.png\" width=\"400\" height=\"70\" alt=\"ChartDB\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://chartdb.io##gh-dark-mode-only\"\u003e\n    \u003cimg src=\"https://github.com/chartdb/chartdb/blob/main/src/assets/logo-dark.png\" width=\"400\" height=\"70\" alt=\"ChartDB\"\u003e\n  \u003c/a\u003e\n  \u003cbr\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cb\u003eOpen-source database diagrams editor\u003c/b\u003e \u003cbr /\u003e\n  \u003cb\u003eNo installations • No Database password required.\u003c/b\u003e \u003cbr /\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003e\n  \u003ca href=\"https://discord.gg/QeFwyWSKwC\"\u003eCommunity\u003c/a\u003e  \u0026bull;\n  \u003ca href=\"https://www.chartdb.io?ref=github_readme\"\u003eWebsite\u003c/a\u003e  \u0026bull;\n  \u003ca href=\"https://chartdb.io/templates?ref=github_readme\"\u003eExamples\u003c/a\u003e  \u0026bull;\n  \u003ca href=\"https://app.chartdb.io?ref=github_readme\"\u003eDemo\u003c/a\u003e\n\u003c/h3\u003e\n\n\u003ch4 align=\"center\"\u003e\n  \u003ca href=\"https://github.com/chartdb/chartdb?tab=AGPL-3.0-1-ov-file#readme\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/chartdb/chartdb?color=blue\" alt=\"ChartDB is released under the AGPL license.\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/chartdb/chartdb/blob/main/CONTRIBUTING.md\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/PRs-Welcome-brightgreen\" alt=\"PRs welcome!\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://discord.gg/QeFwyWSKwC\"\u003e\n    \u003cimg src=\"https://img.shields.io/discord/1277047413705670678?color=5865F2\u0026label=Discord\u0026logo=discord\u0026logoColor=white\" alt=\"Discord community channel\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://x.com/intent/follow?screen_name=jonathanfishner\"\u003e\n    \u003cimg src=\"https://img.shields.io/twitter/follow/jonathanfishner?style=social\"/\u003e\n  \u003c/a\u003e\n\n\u003c/h4\u003e\n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width='700px' src=\"./public/chartdb.png\"\u003e\n\u003c/p\u003e\n\n### 🎉 ChartDB\n\nChartDB is a powerful, web-based database diagramming editor.\nInstantly visualize your database schema with a single **\"Smart Query.\"** Customize diagrams, export SQL scripts, and access all features—no account required. Experience seamless database design here.\n\n**What it does**:\n\n- **Instant Schema Import**\n  Run a single query to instantly retrieve your database schema as JSON. This makes it incredibly fast to visualize your database schema, whether for documentation, team discussions, or simply understanding your data better.\n\n- **AI-Powered Export for Easy Migration**\n  Our AI-driven export feature allows you to generate the DDL script in the dialect of your choice. Whether you're migrating from MySQL to PostgreSQL or from SQLite to MariaDB, ChartDB simplifies the process by providing the necessary scripts tailored to your target database.\n- **Interactive Editing**\n  Fine-tune your database schema using our intuitive editor. Easily make adjustments or annotations to better visualize complex structures.\n\n### Status\n\nChartDB is currently in Public Beta. Star and watch this repository to get notified of updates.\n\n### Supported Databases\n\n- ✅ PostgreSQL (\u003cimg src=\"./src/assets/postgresql_logo_2.png\" width=\"15\"/\u003e + \u003cimg src=\"./src/assets/supabase.png\" alt=\"Supabase\" width=\"15\"/\u003e + \u003cimg src=\"./src/assets/timescale.png\" alt=\"Timescale\" width=\"15\"/\u003e )\n- ✅ MySQL\n- ✅ SQL Server\n- ✅ MariaDB\n- ✅ SQLite (\u003cimg src=\"./src/assets/sqlite_logo_2.png\" width=\"15\"/\u003e + \u003cimg src=\"./src/assets/cloudflare_d1.png\" alt=\"Cloudflare D1\" width=\"15\"/\u003e Cloudflare D1)\n- ✅ CockroachDB\n- ✅ ClickHouse\n\n## Getting Started\n\nUse the [cloud version](https://app.chartdb.io?ref=github_readme_2) or deploy locally:\n\n### How To Use\n\n```bash\nnpm install\nnpm run dev\n```\n\n### Build\n\n```bash\nnpm install\nnpm run build\n```\n\nOr like this if you want to have AI capabilities:\n\n```bash\nnpm install\nVITE_OPENAI_API_KEY=\u003cYOUR_OPEN_AI_KEY\u003e npm run build\n```\n\n### Run the Docker Container\n\n```bash\ndocker run -e OPENAI_API_KEY=\u003cYOUR_OPEN_AI_KEY\u003e -p 8080:80 ghcr.io/chartdb/chartdb:latest\n```\n\n#### Build and Run locally\n\n```bash\ndocker build -t chartdb .\ndocker run -e OPENAI_API_KEY=\u003cYOUR_OPEN_AI_KEY\u003e -p 8080:80 chartdb\n```\n\n#### Using Custom Inference Server\n\n```bash\n# Build\ndocker build \\\n  --build-arg VITE_OPENAI_API_ENDPOINT=\u003cYOUR_ENDPOINT\u003e \\\n  --build-arg VITE_LLM_MODEL_NAME=\u003cYOUR_MODEL_NAME\u003e \\\n  -t chartdb .\n\n# Run\ndocker run \\\n  -e OPENAI_API_ENDPOINT=\u003cYOUR_ENDPOINT\u003e \\\n  -e LLM_MODEL_NAME=\u003cYOUR_MODEL_NAME\u003e \\\n  -p 8080:80 chartdb\n```\n\n\u003e **Note:** You must configure either Option 1 (OpenAI API key) OR Option 2 (Custom endpoint and model name) for AI capabilities to work. Do not mix the two options.\n\nOpen your browser and navigate to `http://localhost:8080`.\n\nExample configuration for a local vLLM server:\n\n```bash\nVITE_OPENAI_API_ENDPOINT=http://localhost:8000/v1\nVITE_LLM_MODEL_NAME=Qwen/Qwen2.5-32B-Instruct-AWQ\n```\n\n## Try it on our website\n\n1. Go to [ChartDB.io](https://chartdb.io?ref=github_readme_2)\n2. Click \"Go to app\"\n3. Choose the database that you are using.\n4. Take the magic query and run it in your database.\n5. Copy and paste the resulting JSON set into ChartDB.\n6. Enjoy Viewing \u0026 Editing!\n\n## 💚 Community \u0026 Support\n\n- [Discord](https://discord.gg/QeFwyWSKwC) (For live discussion with the community and the ChartDB team)\n- [GitHub Issues](https://github.com/chartdb/chartdb/issues) (For any bugs and errors you encounter using ChartDB)\n- [Twitter](https://x.com/intent/follow?screen_name=jonathanfishner) (Get news fast)\n\n## Contributing\n\nWe welcome community contributions, big or small, and are here to guide you along\nthe way. Message us in the [ChartDB Community Discord](https://discord.gg/QeFwyWSKwC).\n\nFor more information on how to contribute, please see our\n[Contributing Guide](/CONTRIBUTING.md).\n\nThis project is released with a [Contributor Code of Conduct](/CODE_OF_CONDUCT.md).\nBy participating in this project, you agree to follow its terms.\n\nThank you for helping us make ChartDB better for everyone :heart:.\n\n## License\n\nChartDB is licensed under the [GNU Affero General Public License v3.0](LICENSE)\n","funding_links":[],"categories":["TypeScript","其他_机器学习与深度学习","Multimedia","visualization","Schema"],"sub_categories":["Image and pictures","Diagrams"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchartdb%2Fchartdb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchartdb%2Fchartdb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchartdb%2Fchartdb/lists"}