@django-stack/cli 0.0.1 → 0.2.0

package/templates/backend/content/migrations/0001_initial.py

@@ -0,0 +1,418 @@
+# Generated by Django 6.1.3 on 2026-11-04 10:30
+
+import content_studio.blocks
+import content_studio.fields
+import content_studio.media_library.fields
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ("content_studio_media_library", "0002_media_metadata_properties"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Category",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=100)),
+                ("slug", models.SlugField(unique=True)),
+                ("description", models.TextField(blank=True)),
+            ],
+            options={
+                "verbose_name_plural": "categories",
+                "ordering": ["name"],
+            },
+        ),
+        migrations.CreateModel(
+            name="FormSubmission",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=200)),
+                ("email", models.EmailField(max_length=254)),
+                ("message", models.TextField(max_length=5000)),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+            ],
+            options={
+                "ordering": ["-created_at"],
+            },
+        ),
+        migrations.CreateModel(
+            name="Menu",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=100)),
+                (
+                    "slug",
+                    models.SlugField(
+                        help_text="The frontend asks for a menu by this name, such as main.",
+                        unique=True,
+                    ),
+                ),
+                ("items", content_studio.blocks.BlockField(blank=True, default=list)),
+            ],
+        ),
+        migrations.CreateModel(
+            name="Redirect",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "old_path",
+                    models.CharField(
+                        help_text="Such as /old-page, without the domain.",
+                        max_length=500,
+                        unique=True,
+                    ),
+                ),
+                (
+                    "new_path",
+                    models.CharField(
+                        help_text="A path on the site or a full URL.", max_length=500
+                    ),
+                ),
+                (
+                    "permanent",
+                    models.BooleanField(
+                        default=True, help_text="301 when on, 302 when off."
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["old_path"],
+            },
+        ),
+        migrations.CreateModel(
+            name="Tag",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=100)),
+                ("slug", models.SlugField(unique=True)),
+            ],
+            options={
+                "ordering": ["name"],
+            },
+        ),
+        migrations.CreateModel(
+            name="Author",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=100)),
+                ("slug", models.SlugField(unique=True)),
+                ("bio", models.TextField(blank=True)),
+                (
+                    "avatar",
+                    content_studio.media_library.fields.MediaField(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="content_studio_media_library.media",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["name"],
+            },
+        ),
+        migrations.CreateModel(
+            name="Page",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "status",
+                    models.CharField(
+                        choices=[("draft", "Draft"), ("published", "Published")],
+                        default="draft",
+                        max_length=20,
+                        verbose_name="status",
+                    ),
+                ),
+                (
+                    "published_at",
+                    models.DateTimeField(
+                        blank=True,
+                        help_text="Leave empty to publish right away. A future date schedules the publication.",
+                        null=True,
+                        verbose_name="publish date",
+                    ),
+                ),
+                (
+                    "seo_title",
+                    models.CharField(
+                        blank=True, max_length=70, verbose_name="SEO title"
+                    ),
+                ),
+                (
+                    "seo_description",
+                    models.CharField(
+                        blank=True, max_length=160, verbose_name="SEO description"
+                    ),
+                ),
+                ("title", models.CharField(max_length=200)),
+                ("slug", models.SlugField()),
+                ("path", models.CharField(editable=False, max_length=500, unique=True)),
+                ("body", content_studio.blocks.BlockField(blank=True, default=list)),
+                ("order", models.PositiveIntegerField(default=0)),
+                (
+                    "parent",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="children",
+                        to="content.page",
+                    ),
+                ),
+                (
+                    "share_image",
+                    content_studio.media_library.fields.MediaField(
+                        blank=True,
+                        help_text="Shown when the page is shared; 1200 × 630 works best.",
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="content_studio_media_library.media",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["order", "title"],
+            },
+        ),
+        migrations.CreateModel(
+            name="SiteSettings",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("site_name", models.CharField(default="{{project_name}}", max_length=100)),
+                ("tagline", models.CharField(blank=True, max_length=200)),
+                (
+                    "seo_description",
+                    models.CharField(
+                        blank=True,
+                        max_length=160,
+                        verbose_name="default SEO description",
+                    ),
+                ),
+                (
+                    "social_links",
+                    models.JSONField(
+                        blank=True,
+                        default=dict,
+                        help_text='Such as {"Mastodon": "https://..."}.',
+                    ),
+                ),
+                ("footer_text", content_studio.fields.HTMLField(blank=True)),
+                (
+                    "home_page",
+                    models.ForeignKey(
+                        blank=True,
+                        help_text="The page shown at /. Without one, the home page lists the latest posts.",
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="content.page",
+                    ),
+                ),
+                (
+                    "logo",
+                    content_studio.media_library.fields.MediaField(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="content_studio_media_library.media",
+                    ),
+                ),
+                (
+                    "share_image",
+                    content_studio.media_library.fields.MediaField(
+                        blank=True,
+                        help_text="The default image for social sharing.",
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="content_studio_media_library.media",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "site settings",
+                "verbose_name_plural": "site settings",
+            },
+        ),
+        migrations.CreateModel(
+            name="Post",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "status",
+                    models.CharField(
+                        choices=[("draft", "Draft"), ("published", "Published")],
+                        default="draft",
+                        max_length=20,
+                        verbose_name="status",
+                    ),
+                ),
+                (
+                    "published_at",
+                    models.DateTimeField(
+                        blank=True,
+                        help_text="Leave empty to publish right away. A future date schedules the publication.",
+                        null=True,
+                        verbose_name="publish date",
+                    ),
+                ),
+                (
+                    "seo_title",
+                    models.CharField(
+                        blank=True, max_length=70, verbose_name="SEO title"
+                    ),
+                ),
+                (
+                    "seo_description",
+                    models.CharField(
+                        blank=True, max_length=160, verbose_name="SEO description"
+                    ),
+                ),
+                ("title", models.CharField(max_length=200)),
+                ("slug", models.SlugField(unique=True)),
+                (
+                    "excerpt",
+                    models.TextField(
+                        blank=True,
+                        help_text="A short summary for lists and search results.",
+                    ),
+                ),
+                ("body", content_studio.blocks.BlockField(blank=True, default=list)),
+                (
+                    "author",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="posts",
+                        to="content.author",
+                    ),
+                ),
+                (
+                    "categories",
+                    models.ManyToManyField(
+                        blank=True, related_name="posts", to="content.category"
+                    ),
+                ),
+                (
+                    "cover",
+                    content_studio.media_library.fields.MediaField(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="content_studio_media_library.media",
+                    ),
+                ),
+                (
+                    "share_image",
+                    content_studio.media_library.fields.MediaField(
+                        blank=True,
+                        help_text="Shown when the page is shared; 1200 × 630 works best.",
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="content_studio_media_library.media",
+                    ),
+                ),
+                (
+                    "tags",
+                    models.ManyToManyField(
+                        blank=True, related_name="posts", to="content.tag"
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["-published_at", "-pk"],
+            },
+        ),
+        migrations.AddConstraint(
+            model_name="page",
+            constraint=models.UniqueConstraint(
+                fields=("parent", "slug"), name="unique_page_slug_per_parent"
+            ),
+        ),
+    ]

package/templates/backend/content/models.py

@@ -0,0 +1,234 @@
+"""
+The content model of {{project_name}}: pages, posts and their taxonomies,
+site settings, menus, redirects and form submissions.
+
+These models are yours: add fields, remove models, create new ones. Every
+model exposed with ``@expose()`` gets routes under /api/ (see
+https://djangoheadless.org/docs/models); register it in ``admin.py`` to edit
+it in Content Studio. After a change, run ``pnpm backend makemigrations``
+and ``pnpm generate:types``.
+"""
+
+from content_studio.blocks import Block, BlockField
+from content_studio.fields import HTMLField
+from content_studio.media_library.fields import MediaField
+from content_studio.media_library.models import Media
+from django.core.exceptions import ValidationError
+from django.db import models
+from django_stack.models import PublishableModel
+from headless import expose, expose_model
+
+from .blocks import BODY_BLOCKS
+
+
+class SeoFields(models.Model):
+    """Search engine and social sharing fields; empty fields fall back to the site settings."""
+
+    seo_title = models.CharField("SEO title", max_length=70, blank=True)
+    seo_description = models.CharField("SEO description", max_length=160, blank=True)
+    share_image = MediaField(file_type="image", help_text="Shown when the page is shared; 1200 × 630 works best.")
+
+    class Meta:
+        abstract = True
+
+
+@expose(read_only=True, lookup_fields=["slug"])
+class Category(models.Model):
+    name = models.CharField(max_length=100)
+    slug = models.SlugField(unique=True)
+    description = models.TextField(blank=True)
+
+    class Meta:
+        verbose_name_plural = "categories"
+        ordering = ["name"]
+
+    def __str__(self):
+        return self.name
+
+    def get_absolute_url(self):
+        return f"/category/{self.slug}"
+
+
+@expose(read_only=True, lookup_fields=["slug"])
+class Tag(models.Model):
+    name = models.CharField(max_length=100)
+    slug = models.SlugField(unique=True)
+
+    class Meta:
+        ordering = ["name"]
+
+    def __str__(self):
+        return self.name
+
+    def get_absolute_url(self):
+        return f"/tag/{self.slug}"
+
+
+@expose(read_only=True, lookup_fields=["slug"])
+class Author(models.Model):
+    name = models.CharField(max_length=100)
+    slug = models.SlugField(unique=True)
+    bio = models.TextField(blank=True)
+    avatar = MediaField(file_type="image")
+
+    class Meta:
+        ordering = ["name"]
+
+    def __str__(self):
+        return self.name
+
+
+@expose(read_only=True)
+class Page(PublishableModel, SeoFields):
+    """A page of the site at /<path>, such as /about or /about/team."""
+
+    title = models.CharField(max_length=200)
+    slug = models.SlugField()
+    parent = models.ForeignKey("self", null=True, blank=True, on_delete=models.PROTECT, related_name="children")
+    path = models.CharField(max_length=500, unique=True, editable=False)
+    body = BlockField(blocks=BODY_BLOCKS, blank=True, default=list, max_num=50)
+    order = models.PositiveIntegerField(default=0)
+
+    class Meta:
+        ordering = ["order", "title"]
+        constraints = [models.UniqueConstraint(fields=["parent", "slug"], name="unique_page_slug_per_parent")]
+
+    def __str__(self):
+        return self.title
+
+    def save(self, *args, **kwargs):
+        old_path = self.path
+        self.path = self.build_path()
+        super().save(*args, **kwargs)
+        if old_path and old_path != self.path:
+            for child in self.children.all():
+                child.save()
+
+    def get_absolute_url(self):
+        return f"/{self.path}"
+
+    def build_path(self) -> str:
+        return f"{self.parent.path}/{self.slug}" if self.parent else self.slug
+
+    def clean(self):
+        ancestor = self.parent
+        while ancestor is not None:
+            if ancestor.pk == self.pk:
+                raise ValidationError({"parent": "A page cannot be its own parent or ancestor."})
+            ancestor = ancestor.parent
+
+
+@expose(read_only=True, lookup_fields=["slug"])
+class Post(PublishableModel, SeoFields):
+    """A blog post at /blog/<slug>."""
+
+    title = models.CharField(max_length=200)
+    slug = models.SlugField(unique=True)
+    excerpt = models.TextField(blank=True, help_text="A short summary for lists and search results.")
+    cover = MediaField(file_type="image")
+    body = BlockField(blocks=BODY_BLOCKS, blank=True, default=list, max_num=50)
+    author = models.ForeignKey(Author, null=True, blank=True, on_delete=models.SET_NULL, related_name="posts")
+    categories = models.ManyToManyField(Category, blank=True, related_name="posts")
+    tags = models.ManyToManyField(Tag, blank=True, related_name="posts")
+
+    class Meta:
+        ordering = ["-published_at", "-pk"]
+
+    def __str__(self):
+        return self.title
+
+    def get_absolute_url(self):
+        return f"/blog/{self.slug}"
+
+
+class LinkBlock(Block):
+    label = models.CharField(max_length=100)
+    page = models.ForeignKey(Page, null=True, blank=True, on_delete=models.SET_NULL)
+    url = models.CharField(max_length=500, blank=True, help_text="Used when no page is chosen.")
+
+    class Meta:
+        name = "link"
+        description = "A link to a page or a URL"
+        icon = "ph-bold ph-link"
+
+
+@expose(read_only=True, lookup_fields=["slug"])
+class Menu(models.Model):
+    """A navigation menu, such as "main" in the header or "footer"."""
+
+    name = models.CharField(max_length=100)
+    slug = models.SlugField(unique=True, help_text="The frontend asks for a menu by this name, such as main.")
+    items = BlockField(blocks=[LinkBlock], blank=True, default=list, max_num=20)
+
+    def __str__(self):
+        return self.name
+
+
+@expose(singleton=True, read_only=True)
+class SiteSettings(models.Model):
+    site_name = models.CharField(max_length=100, default="{{project_name}}")
+    tagline = models.CharField(max_length=200, blank=True)
+    logo = MediaField(file_type="image")
+    home_page = models.ForeignKey(
+        Page,
+        null=True,
+        blank=True,
+        on_delete=models.SET_NULL,
+        related_name="+",
+        help_text="The page shown at /. Without one, the home page lists the latest posts.",
+    )
+    seo_description = models.CharField("default SEO description", max_length=160, blank=True)
+    share_image = MediaField(file_type="image", help_text="The default image for social sharing.")
+    social_links = models.JSONField(default=dict, blank=True, help_text='Such as {"Mastodon": "https://..."}.')
+    footer_text = HTMLField(blank=True)
+
+    class Meta:
+        verbose_name = "site settings"
+        verbose_name_plural = "site settings"
+
+    def __str__(self):
+        return self.site_name
+
+
+@expose(read_only=True)
+class Redirect(models.Model):
+    """A redirect the frontend applies before showing its not found page."""
+
+    old_path = models.CharField(max_length=500, unique=True, help_text="Such as /old-page, without the domain.")
+    new_path = models.CharField(max_length=500, help_text="A path on the site or a full URL.")
+    permanent = models.BooleanField(default=True, help_text="301 when on, 302 when off.")
+
+    class Meta:
+        ordering = ["old_path"]
+
+    def __str__(self):
+        return f"{self.old_path} → {self.new_path}"
+
+    def save(self, *args, **kwargs):
+        self.old_path = "/" + self.old_path.strip().strip("/")
+        super().save(*args, **kwargs)
+
+
+@expose(fields=["id", "name", "email", "message", "created_at"])
+class FormSubmission(models.Model):
+    """A contact form submission. Anyone may create one (PUBLIC_CREATE); only editors read them."""
+
+    name = models.CharField(max_length=200)
+    email = models.EmailField()
+    message = models.TextField(max_length=5000)
+    created_at = models.DateTimeField(auto_now_add=True)
+
+    class Meta:
+        ordering = ["-created_at"]
+
+    def __str__(self):
+        return f"{self.name} <{self.email}>"
+
+
+# The media library, read-only: `?expand=cover` and blocks return media items
+# with their URL and image sizes.
+expose_model(
+    Media,
+    read_only=True,
+    fields=["id", "name", "alt_text", "type", "file", "metadata", "properties"],
+)