Skip to content

Quickstart

Get started with Django ERD Generator in 5 minutes.

Generate Your First ERD

1. Basic ERD Generation

Generate an ERD for all apps in Mermaid format:

python manage.py generate_erd -d mermaid

2. Save to File

Save the ERD to a file:

python manage.py generate_erd -d mermaid -o erd.md

3. Filter by Apps

Generate ERD for specific apps only:

python manage.py generate_erd -a shopping,polls -d mermaid

4. Different Formats

Mermaid.js: 

python manage.py generate_erd -d mermaid -o erd.md

PlantUML: 

python manage.py generate_erd -d plantuml -o erd.puml

dbdiagram.io: 

python manage.py generate_erd -d dbdiagram -o erd.txt

Generate Data Dictionary

Create comprehensive documentation:

python manage.py generate_data_dictionary -o docs/data_dictionary.md

View in Browser

Mermaid.js Live Editor

  1. Generate ERD: python manage.py generate_erd -d mermaid -o erd.md
  2. Copy the output
  3. Paste into Mermaid Live Editor

PlantUML Server

  1. Generate ERD: python manage.py generate_erd -d plantuml -o erd.puml
  2. Upload to PlantUML Server

dbdiagram.io

  1. Generate ERD: python manage.py generate_erd -d dbdiagram -o erd.txt
  2. Import into dbdiagram.io

Example Output

Sample Model

from django.db import models

class Customer(models.Model):
    first_name = models.CharField(max_length=100)
    last_name = models.CharField(max_length=100)
    email = models.EmailField(unique=True)

class Order(models.Model):
    customer = models.ForeignKey(Customer, on_delete=models.CASCADE)
    order_date = models.DateTimeField(auto_now_add=True)
    total = models.DecimalField(max_digits=10, decimal_places=2)

Generated Mermaid ERD

erDiagram
    Customer {
        varchar first_name
        varchar last_name
        varchar email
    }
    Order {
        ForeignKey customer
        datetime order_date
        decimal total
    }
    Customer ||--o{ Order : places

Next Steps