drawdb/README.md
2025-04-28 09:31:38 +04:00

65 lines
2.1 KiB
Markdown

<div align="center">
<sup>Special thanks to:</sup>
<br>
<a href="https://www.warp.dev/drawdb/" target="_blank">
<img alt="Warp sponsorship" width="280" src="https://github.com/user-attachments/assets/c7f141e7-9751-407d-bb0e-d6f2c487b34f">
<br>
<b>Next-gen AI-powered intelligent terminal for all platforms</b>
</a>
</div>
<br/>
<br/>
<div align="center">
<img width="64" alt="drawdb logo" src="./src/assets/icon-dark.png">
<h1>drawDB</h1>
</div>
<h3 align="center">Free, simple, and intuitive database schema editor and SQL generator.</h3>
<div align="center" style="margin-bottom:12px;">
<a href="https://drawdb.app/" style="display: flex; align-items: center;">
<img src="https://img.shields.io/badge/Start%20building-grey" alt="drawDB"/>
</a>
<a href="https://discord.gg/BrjZgNrmR6" style="display: flex; align-items: center;">
<img src="https://img.shields.io/discord/1196658537208758412.svg?label=Join%20the%20Discord&logo=discord" alt="Discord"/>
</a>
<a href="https://x.com/drawDB_" style="display: flex; align-items: center;">
<img src="https://img.shields.io/badge/Follow%20us%20on%20X-blue?logo=X" alt="Follow us on X"/>
</a>
</div>
<h3 align="center"><img width="700" style="border-radius:5px;" alt="demo" src="drawdb.png"></h3>
DrawDB is a robust and user-friendly database entity relationship (DBER) editor right in your browser. Build diagrams with a few clicks, export sql scripts, customize your editor, and more without creating an account. See the full set of features [here](https://drawdb.app/).
## Getting Started
### Local Development
```bash
git clone https://github.com/drawdb-io/drawdb
cd drawdb
npm install
npm run dev
```
### Build
```bash
git clone https://github.com/drawdb-io/drawdb
cd drawdb
npm install
npm run build
```
### Docker Build
```bash
docker build -t drawdb .
docker run -p 3000:80 drawdb
```
If you wish to work with sharing, set up [server](https://github.com/drawdb-io/drawdb-server) and environment variables according to `.env.sample`. This is not required unless you want to share files.