Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chartdb/chartdb

Free and open-source database diagrams editor, visualize and design your DB with a single query.
https://github.com/chartdb/chartdb

database db db-migration editor erd mariadb mssql mysql postgresql react react-flow schema-migrations sql sqlite typescript visualization xyflow

Last synced: 25 days ago
JSON representation

Free and open-source database diagrams editor, visualize and design your DB with a single query.

Awesome Lists containing this project

README

        



ChartDB


ChartDB




Open-source database diagrams editor

No installations β€’ No Database password required.


Community β€’
Website β€’
Demo



ChartDB is released under the AGPL license.


PRs welcome!


Discord community channel



---



### πŸŽ‰ ChartDB

ChartDB is a powerful, web-based database diagramming editor.
Instantly 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.

**What it does**:

- **Instant Schema Import**
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.

- **AI-Powered Export for Easy Migration**
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.
- **Interactive Editing**
Fine-tune your database schema using our intuitive editor. Easily make adjustments or annotations to better visualize complex structures.

### Status

ChartDB is currently in Public Beta. Star and watch this repository to get notified of updates.

### Supported Databases

- βœ… PostgreSQL ( + Supabase + Timescale )
- βœ… MySQL
- βœ… SQL Server
- βœ… MariaDB
- βœ… SQLite
- βœ… ClickHouse

## Getting Started

Use the [cloud version](https://app.chartdb.io/) or deploy locally:

### How To Use

```bash
npm install
npm run dev
```

### Build

```bash
npm install
npm run build
```

Or like this if you want to have AI capabilities:

```
npm install
VITE_OPENAI_API_KEY= npm run build
```

### Running the Docker Container

```bash
docker build -t chartdb .
docker run -p 8080:80 chartdb
```

Open your browser and navigate to `http://localhost:8080`.

## Try it on our website

1. Go to [ChartDB.io](https://chartdb.io)
2. Click "Go to app"
3. Choose the database that you are using.
4. Take the magic query and run it in your database.
5. Copy and paste the resulting JSON set into ChartDB.
6. Enjoy Viewing & Editing!

## πŸ’š Community & Support

- [Discord](https://discord.gg/QeFwyWSKwC) (For live discussion with the community and the ChartDB team)
- [GitHub Issues](https://github.com/chartdb/chartdb/issues) (For any bugs and errors you encounter using ChartDB)
- [Twitter](https://x.com/chartdb_io) (Get news fast)

## Contributing

We welcome community contributions, big or small, and are here to guide you along
the way. Message us in the [ChartDB Community Discord](https://discord.gg/QeFwyWSKwC).

For more information on how to contribute, please see our
[Contributing Guide](/CONTRIBUTING.md).

This project is released with a [Contributor Code of Conduct](/CODE_OF_CONDUCT.md).
By participating in this project, you agree to follow its terms.

Thank you for helping us make ChartDB better for everyone :heart:.

## License

ChartDB is licensed under the [GNU Affero General Public License v3.0](LICENSE)