feat: Sprint 0 — Django API scaffold (users, stores, categories, JWT auth)

.env.example

@@ -0,0 +1,15 @@
+# Django
+DEBUG=True
+SECRET_KEY=your-secret-key-here
+ALLOWED_HOSTS=localhost,127.0.0.1
+
+# Database
+DB_NAME=liemo_db
+DB_USER=your_mac_username
+DB_PASSWORD=
+DB_HOST=localhost
+DB_PORT=5432
+
+# JWT
+JWT_ACCESS_TOKEN_LIFETIME_MINUTES=60
+JWT_REFRESH_TOKEN_LIFETIME_DAYS=7

.gitignore

@@ -1,207 +1,32 @@
-# Byte-compiled / optimized / DLL files
+# Python
 __pycache__/
-*.py[codz]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
+*.py[cod]
+*.pyo
+*.pyd
 .Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py.cover
-.hypothesis/
-.pytest_cache/
-cover/
+*.pyc
 
-# Translations
-*.mo
-*.pot
+# Virtual Environment
+venv/
+env/
+.venv/
 
-# Django stuff:
+# Django
 *.log
 local_settings.py
 db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# UV
-#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#uv.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-#poetry.toml
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
-#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
-#pdm.lock
-#pdm.toml
-.pdm-python
-.pdm-build/
+media/
+staticfiles/
 
-# pixi
-#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
-#pixi.lock
-#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
-#   in the .venv directory. It is recommended not to include this directory in version control.
-.pixi
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
+# Environment
 .env
-.envrc
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
-
-# Abstra
-# Abstra is an AI-powered process automation framework.
-# Ignore directories containing user credentials, local state, and settings.
-# Learn more at https://abstra.io/docs
-.abstra/
-
-# Visual Studio Code
-#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
-#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
-#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
-#  you could uncomment the following to ignore the entire vscode folder
-# .vscode/
-
-# Ruff stuff:
-.ruff_cache/
 
-# PyPI configuration file
-.pypirc
+# macOS
+.DS_Store
 
-# Cursor
-#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
-#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
-#  refer to https://docs.cursor.com/context/ignore-files
-.cursorignore
-.cursorindexingignore
+# VS Code
+.vscode/
 
-# Marimo
-marimo/_static/
-marimo/_lsp/
-__marimo__/
+# IDE
+*.swp
+*.swo

apps/categories/admin.py

@@ -0,0 +1,10 @@
+from django.contrib import admin
+from .models import Category
+
+
+@admin.register(Category)
+class CategoryAdmin(admin.ModelAdmin):
+    list_display = ['name', 'slug', 'parent', 'is_active']
+    list_filter = ['is_active']
+    search_fields = ['name', 'slug']
+    prepopulated_fields = {'slug': ('name',)}

apps/categories/models.py

@@ -0,0 +1,22 @@
+from django.db import models
+
+
+class Category(models.Model):
+    name = models.CharField(max_length=100)
+    slug = models.SlugField(unique=True)
+    icon_url = models.URLField(blank=True)
+    parent = models.ForeignKey(
+        'self', null=True, blank=True,
+        on_delete=models.SET_NULL,
+        related_name='children'
+    )
+    is_active = models.BooleanField(default=True)
+    created_at = models.DateTimeField(auto_now_add=True)
+
+    class Meta:
+        db_table = 'categories'
+        verbose_name_plural = 'Categories'
+        ordering = ['name']
+
+    def __str__(self):
+        return self.name

apps/categories/serializers.py

@@ -0,0 +1,8 @@
+from rest_framework import serializers
+from .models import Category
+
+
+class CategorySerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Category
+        fields = ['id', 'name', 'slug', 'icon_url', 'parent', 'is_active']

apps/categories/urls.py

@@ -0,0 +1,10 @@
+from django.urls import path, include
+from rest_framework.routers import DefaultRouter
+from .views import CategoryViewSet
+
+router = DefaultRouter()
+router.register(r'', CategoryViewSet, basename='category')
+
+urlpatterns = [
+    path('', include(router.urls)),
+]

apps/categories/views.py

@@ -0,0 +1,12 @@
+from rest_framework import viewsets
+from rest_framework.permissions import IsAuthenticatedOrReadOnly
+from drf_spectacular.utils import extend_schema
+from .models import Category
+from .serializers import CategorySerializer
+
+
+@extend_schema(tags=['Categories'])
+class CategoryViewSet(viewsets.ReadOnlyModelViewSet):
+    queryset = Category.objects.filter(is_active=True)
+    serializer_class = CategorySerializer
+    permission_classes = [IsAuthenticatedOrReadOnly]

apps/stores/admin.py

@@ -0,0 +1,15 @@
+from django.contrib import admin
+from .models import Store, StoreLink
+
+
+class StoreLinkInline(admin.TabularInline):
+    model = StoreLink
+    extra = 1
+
+
+@admin.register(Store)
+class StoreAdmin(admin.ModelAdmin):
+    list_display = ['name', 'admin', 'status', 'is_live', 'is_verified', 'avg_rating']
+    list_filter = ['status', 'is_live', 'is_verified']
+    search_fields = ['name', 'admin__email']
+    inlines = [StoreLinkInline]

apps/stores/models.py

@@ -0,0 +1,62 @@
+from django.db import models
+from django.utils.text import slugify
+from apps.users.models import User
+from apps.categories.models import Category
+
+
+class Store(models.Model):
+    class Status(models.TextChoices):
+        ACTIVE = 'ACTIVE', 'Active'
+        PENDING = 'PENDING', 'Pending'
+        SUSPENDED = 'SUSPENDED', 'Suspended'
+
+    admin = models.OneToOneField(User, on_delete=models.CASCADE, related_name='store')
+    name = models.CharField(max_length=200)
+    slug = models.SlugField(unique=True, blank=True)
+    bio = models.TextField(blank=True)
+    logo_url = models.URLField(blank=True)
+    is_verified = models.BooleanField(default=False)
+    is_live = models.BooleanField(default=False)
+    avg_rating = models.DecimalField(max_digits=3, decimal_places=2, default=0.00)
+    status = models.CharField(max_length=20, choices=Status.choices, default=Status.PENDING)
+    categories = models.ManyToManyField(Category, blank=True, related_name='stores')
+    follower_count = models.PositiveIntegerField(default=0)
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        db_table = 'stores'
+
+    def save(self, *args, **kwargs):
+        if not self.slug:
+            self.slug = slugify(self.name)
+        super().save(*args, **kwargs)
+
+    def __str__(self):
+        return self.name
+
+
+class StoreLink(models.Model):
+    class Platform(models.TextChoices):
+        TIKTOK = 'TIKTOK', 'TikTok'
+        FACEBOOK = 'FACEBOOK', 'Facebook'
+        INSTAGRAM = 'INSTAGRAM', 'Instagram'
+        SHOPEE = 'SHOPEE', 'Shopee'
+        YOUTUBE = 'YOUTUBE', 'YouTube'
+        TWITTER = 'TWITTER', 'Twitter/X'
+        WEBSITE = 'WEBSITE', 'Website'
+
+    store = models.ForeignKey(Store, on_delete=models.CASCADE, related_name='links')
+    platform = models.CharField(max_length=20, choices=Platform.choices)
+    url = models.URLField()
+    label = models.CharField(max_length=100, blank=True)
+    click_count = models.PositiveIntegerField(default=0)
+    display_order = models.PositiveIntegerField(default=0)
+    created_at = models.DateTimeField(auto_now_add=True)
+
+    class Meta:
+        db_table = 'store_links'
+        ordering = ['display_order']
+
+    def __str__(self):
+        return f'{self.store.name} - {self.platform}'