Skip to content

Update README.md #516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #516

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 24 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,47 +1,40 @@
<h3 align="center">
<img width="80" alt="drawdb logo" src="./src/assets/icon-dark.png">
</h3>
<h1 align="center">
<img width="80" alt="drawdb logo" src="./src/assets/icon-dark.png">
<br>drawDB
</h1>

<h3 align="center">Free, simple, and intuitive database design tool and SQL generator.</h3>
<h3 align="center">✨ Visual Database Designer • SQL Generator • No Account Required ✨</h3>

<p align="center">
<a href="https://drawdb.vercel.app/">drawDB</a>
·
<a href="https://discord.gg/BrjZgNrmR6">Discord</a>
<a href="https://drawdb.vercel.app/">Live Demo</a> •
<a href="https://discord.gg/BrjZgNrmR6">Discord Community</a> •
<a href="#features">Features</a>
</p>

<h3 align="center"><img width="700" style="border-radius:5px;" alt="demo" src="drawdb.gif"></h3>
<p align="center">
<img width="700" style="border-radius:8px;box-shadow:0 4px 12px rgba(0,0,0,0.15);" alt="drawDB in action" src="drawdb.gif">
</p>

## drawDB
---

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.vercel.app/).
## 🚀 Features That Make You Productive

## Getting Started
- **Visual ERD Designer** - Create database diagrams with drag-and-drop simplicity
- **Instant SQL Generation** - Export PostgreSQL, MySQL, and SQLite scripts
- **Zero Configuration** - Works directly in your browser - no signup required
- **Custom Themes** - Light/dark mode with customizable canvas colors
- **Keyboard Friendly** - Quick navigation with keyboard shortcuts
- **Shareable Projects** - Export/import your database designs as JSON

### Local Development
[Explore all features →](https://drawdb.vercel.app/)

```bash
git clone https://github.com/drawdb-io/drawdb
cd drawdb
npm install
npm run dev
```
---

### Build
## ⚡ Quick Start

### Local Development
```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
```


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.

npm run dev