drawDB/README.md

52 lines
1.7 KiB
Markdown
Raw Normal View History

2024-11-10 17:00:54 +08:00
<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>
2024-04-06 17:39:13 +08:00
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/).
2024-04-06 17:39:13 +08:00
## 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
```
2024-04-07 23:26:48 +08:00
### Docker Build
2024-04-07 23:26:48 +08:00
```bash
docker build -t drawdb .
docker run -p 3000:80 drawdb
```
2024-04-06 17:39:13 +08:00
Set up the [server](https://github.com/drawdb-io/drawdb-server) and environment variables according to `.env.sample` for the survey and bug report forms.