Demo Model Setup

Let's create a demo application (e.g., a blog) and models to play with. You'll define your models, register them with ORMBridge for automatic CRUD support, and optionally register them with Django Admin to manage data from the backend.

1. Create the Test App

Run the following command to create a new Django app (here, named "blog"):

python manage.py startapp blog

Then, add the new app to your settings file (e.g., in /backend/backend/settings.py):

INSTALLED_APPS = [
    # ...,
    "blog",
    # ...
]

2. Define Demo Models

Create or update the file /backend/blog/models.py with the following content:

from django.db import models
from django.conf import settings

class Category(models.Model):
    name = models.CharField(max_length=100)
    slug = models.SlugField(unique=True)
    
    def __str__(self):
        return self.name

class Post(models.Model):
    title = models.CharField(max_length=200)
    content = models.TextField()
    published_date = models.DateTimeField(auto_now_add=True)
    author = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
    categories = models.ManyToManyField(Category, related_name='posts')
    
    def __str__(self):
        return self.title

3. (Optional) Register Models with Django Admin

Registering your models with Django Admin isn’t required for ORMBridge, but it allows you to manually add or modify data from the Django backend. To do so, update /backend/blog/admin.py with:

from django.contrib import admin
from .models import Post, Category

admin.site.register(Post)
admin.site.register(Category)

4. Register Models with ORMBridge

Create a file /backend/blog/crud.py with the following content to register your models for automatic CRUD support:

from ormbridge.adaptors.django.config import registry
from ormbridge.adaptors.django.permissions import AllowAllPermission
from ormbridge.core.config import ModelConfig
from .models import Post, Category
from django.contrib.auth import get_user_model

User = get_user_model()

# Register Post model
registry.register(
    Post,
    ModelConfig(
        model=Post,
        filterable_fields="__all__",             # Enable filtering on all fields
        searchable_fields={'title', 'content'},    # Enable search on these fields
        ordering_fields={'published_date', 'title'},  # Enable ordering
        permissions=[AllowAllPermission]           # Use proper permissions in production
    )
)

# Register Category model
registry.register(
    Category,
    ModelConfig(
        model=Category,
        filterable_fields="__all__",
        searchable_fields={'name'},
        ordering_fields={'name'},
        permissions=[AllowAllPermission]
    )
)

# Register the Django User model for frontend access
registry.register(
    User,
    ModelConfig(
        model=User,
        filterable_fields=("id", "username", "email"),  # Customize as needed
        searchable_fields={"username", "email"},
        ordering_fields={"username"},
        permissions=[AllowAllPermission]
    )
)

Note: ORMBridge will autodiscover this file, so you don't need to import it manually.

5. Test Your Demo Models

After creating the models and registration files, run the server:

python manage.py runserver

You should see a message indicating that ORMBridge is running and the models being exposed. Additionally, if you registered your models with Django Admin, you can log in to the admin panel to add or modify data.

Now you are ready to set up your frontend.