mirror of
https://github.com/chartdb/chartdb.git
synced 2025-12-30 07:59:49 -06:00
Add README.md
This commit is contained in:
committed by
Jonathan Fishner
parent
4f73b0a0d7
commit
1ff3fc3840
83
README.md
83
README.md
@@ -1 +1,82 @@
|
||||
# ChartDB
|
||||
|
||||
<h1 align="center">
|
||||
<a href="https://chartdb.io"><img src="https://github.com/chartdb/chartdb/blob/main/src/assets/logo.png?raw=true" width="400" height="70" alt="ChartDB"></a>
|
||||
<br>
|
||||
</h1>
|
||||
|
||||
<p align="center">
|
||||
<b>Open-source database diagrams editor</b> <br />
|
||||
</p>
|
||||
|
||||
<h3 align="center">
|
||||
<a href="https://join.slack.com/t/chartdbcommunity/shared_invite/_1234">Community</a> |
|
||||
<a href="https://www.chartdb.io">Website</a>
|
||||
</h3>
|
||||
|
||||
<h4 align="center">
|
||||
<a href="https://github.com/chartdb/chartdb?tab=AGPL-3.0-1-ov-file#readme">
|
||||
<img src="https://img.shields.io/github/license/chartdb/chartdb?color=blue" alt="ChartDB is released under the MIT license." />
|
||||
</a>
|
||||
<a href="https://github.com/chartdb/chartdb/blob/main/CONTRIBUTING.md">
|
||||
<img src="https://img.shields.io/badge/PRs-Welcome-brightgreen" alt="PRs welcome!" />
|
||||
</a>
|
||||
<a href="https://join.slack.com/t/chartdbcommunity/shared_invite/_1234">
|
||||
<img src="https://img.shields.io/badge/Join%20Slack-purple?logo=slack&link=https%3A%2F%2Fjoin.slack.com%2Ft%2Fchartdbcommunity%2Fshared_invite%2F_1234" alt="Slack community channel" />
|
||||
</a>
|
||||
<a href="https://twitter.com/ChartDB">
|
||||
<img src="https://img.shields.io/twitter/follow/ChartDB?style=social"/>
|
||||
</a>
|
||||
|
||||
</h4>
|
||||
|
||||
---
|
||||
|
||||
**🎉 ChartDB**:
|
||||
ChartDB is a powerful and intuitive database diagramming editor that runs as a SaaS application via a website.
|
||||
Effortlessly visualize and design your database schemas with a single **Smart Query** that fetches your entire database structure.
|
||||
Customize your diagrams, export SQL scripts, and explore a full suite of features—all without the need to create an account.
|
||||
Dive into a seamless database design experience and discover the complete feature set here.
|
||||
|
||||
## Status
|
||||
|
||||
ChartDB is currently in Public Beta. Star and watch this repository to get notified of updates.
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
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!
|
||||
|
||||
### Supported Databases
|
||||
|
||||
- ✅ PostgresSQL
|
||||
- ✅ MySQL
|
||||
- ✅ SQL Server
|
||||
- ✅ MariaDB
|
||||
- ✅ SQL Lite
|
||||
|
||||
## 💚 Community & Support
|
||||
|
||||
- [Slack](https://chartdb.io/slack) (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://twitter.com/chartdb) (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 Slack](https://join.slack.com/t/chartdbcommunity/shared_invite/213123123213). Once you contribute, ping us in Slack and we'll send you some ChartDB swag!
|
||||
|
||||
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) and as commercial software.
|
||||
|
||||
Reference in New Issue
Block a user