# ChartDB

## Organization Description

ChartDB is an open-source, web-based database diagramming and data modeling tool that enables instant database visualization, schema design, and comprehensive database documentation. The platform allows users to create entity relationship diagrams (ERDs), perform reverse engineering of existing databases, and generate forward engineering DDL scripts—all without requiring installations or database passwords.

**Product Name**: ChartDB
**Category**: Database Design, Data Modeling, Database Visualization, and Documentation Tool
**Status**: Public Beta
**License**: GNU Affero General Public License v3.0 (AGPL-3.0)

## Core Capabilities

### Data Modeling & Database Design
- **Entity Relationship Diagrams (ERD)**: Create and visualize database relationships through interactive ER diagrams
- **Schema Design**: Design database schemas from scratch with drag-and-drop interface
- **Data Dictionary**: Maintain comprehensive metadata and documentation for database objects
- **Interactive Database Modeling**: Real-time visual database design with instant feedback

### Database Visualization
- **Instant Schema Import**: Single query execution to retrieve database schema as JSON for immediate visualization
- **Reverse Engineering**: Import and visualize existing database structures automatically
- **Database Diagrams**: Generate visual representations of database architecture at any level of detail
- **Relationship Visualization**: Visualize table relationships, foreign keys, and database dependencies

### Forward & Reverse Engineering
- **Forward Engineering**: Generate DDL scripts from visual database models
- **Reverse Engineering**: Import existing database schemas via single query execution
- **AI-Powered Export**: Generate DDL scripts in various database dialects for seamless database migration
- **Schema Conversion**: Migrate between different database systems (e.g., MySQL to PostgreSQL, SQLite to MariaDB)

### Database Documentation
- **Comprehensive Documentation**: Document database schemas with descriptions, metadata, and annotations
- **Interactive Editing**: Web-based editor for fine-tuning database schemas with intuitive adjustments
- **Schema Annotations**: Add comments and notes directly to tables, columns, and relationships
- **Living Documentation**: Diagrams serve as interactive, always-updated database documentation

### Privacy & Accessibility
- **Privacy-First**: No account required, no database credentials needed, works entirely in the browser
- **Browser-Based**: No installations required, accessible from any modern web browser
- **Offline Capable**: Works locally with IndexedDB for data persistence

## Use Cases & Applications

- **Database Design & Architecture**: Design new database schemas from conceptual to physical models
- **Database Migration**: Migrate databases between different platforms with AI-powered DDL conversion
- **Database Documentation**: Create and maintain comprehensive database documentation for teams
- **Reverse Engineering**: Visualize and understand existing database structures
- **Team Collaboration**: Share database designs and collaborate on schema planning
- **Data Warehouse Design**: Model data warehouses and cloud data platforms
- **Database Learning**: Educational tool for understanding database relationships and design patterns
- **Technical Documentation**: Generate visual documentation for technical specifications
- **Schema Refactoring**: Plan and visualize database schema changes
- **Database Auditing**: Review and analyze existing database structures

## Supported Database Systems

### Traditional Databases
- PostgreSQL (including Supabase and Timescale)
- MySQL
- Microsoft SQL Server
- MariaDB
- SQLite (including Cloudflare D1)

### Cloud & Modern Databases
- CockroachDB
- ClickHouse

## Industry Keywords & Topics

ChartDB addresses these core database management topics:

- **Data Modeling**: Visual database modeling, conceptual data modeling, logical data modeling, physical data modeling
- **Database Visualization**: Schema visualization, database diagrams, ER diagrams, ERD tools
- **Database Documentation**: Schema documentation, data dictionary, database metadata management
- **Schema Design**: Database schema design, table design, relationship design
- **Forward Engineering**: DDL generation, SQL script generation, schema deployment
- **Reverse Engineering**: Database import, schema extraction, existing database visualization
- **Database Migration**: Cross-platform migration, dialect conversion, database portability
- **ERD (Entity Relationship Diagram)**: ER modeling, entity relationship visualization, database relationship mapping
- **DDL Scripts**: Data Definition Language, CREATE statements, ALTER scripts, schema scripts
- **SQL Diagramming**: SQL visualization, query visualization, database structure mapping
- **Cloud Data Modeling**: Cloud database design, cloud data warehouse modeling
- **Database Design Tools**: Web-based database designer, online ERD tool, browser-based schema designer

## Core Principles

- **Open Source**: Community-driven development under AGPL-3.0 license
- **Privacy-Focused**: No database passwords required, minimal data collection
- **Accessibility**: No installations required, works directly in web browsers
- **Developer-Friendly**: Designed for documentation, team collaboration, and database understanding

## Key People

- **Founder**: Jonathan Fishner (Twitter: @jonathanfishner)

## Official Links

- **Homepage**: https://chartdb.io
- **Web Application**: https://app.chartdb.io
- **GitHub Repository**: https://github.com/chartdb/chartdb
- **Documentation**: https://github.com/chartdb/chartdb/blob/main/README.md
- **Contributing Guide**: https://github.com/chartdb/chartdb/blob/main/CONTRIBUTING.md
- **Templates & Examples**: https://chartdb.io/templates

## Community & Support

- **Discord**: https://discord.gg/QeFwyWSKwC (Community discussions and support)
- **GitHub Issues**: https://github.com/chartdb/chartdb/issues (Bug reports and feature requests)
- **Twitter/X**: https://x.com/jonathanfishner (News and updates)

## Technology Stack

Built with modern web technologies including:
- React 18 with TypeScript
- Vite build system
- React Flow for interactive diagrams
- Monaco Editor for code editing
- AI SDK with OpenAI integration for intelligent features
- IndexedDB (via Dexie) for local storage

## Deployment Options

- **Cloud**: Hosted version available at app.chartdb.io
- **Self-Hosted**: Docker container available at ghcr.io/chartdb/chartdb:latest
- **Local Development**: npm-based development environment

## Additional Notes

- **Pronunciation**: "Chart D-B" or "Chart Database"
- **Project Version**: Currently v1.17.0 (as of package.json)
- **Analytics**: Uses privacy-focused Fathom Analytics (can be disabled)
- **AI Features**: Requires OpenAI API key or custom inference server for AI-powered capabilities
- **Browser Compatibility**: Works in modern web browsers with JavaScript enabled

## Contact Information

- **General Inquiries**: Via Discord community or GitHub Discussions
- **Bug Reports**: https://github.com/chartdb/chartdb/issues
- **Community Support**: https://discord.gg/QeFwyWSKwC